Skip to content

Commit 39ecfc3

Browse files
committed
updated docs
1 parent 860ae44 commit 39ecfc3

File tree

2 files changed

+38
-4
lines changed

2 files changed

+38
-4
lines changed

R/fit.R

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,23 @@
1010
#' routine.
1111
#'
1212
#' @param object An object of class `model_spec`
13-
#' @param x Either an R formula, a data frame of predictors, or a
14-
#' recipe object.
13+
#' @param formula An object of class "formula" (or one that can
14+
#' be coerced to that class): a symbolic description of the model
15+
#' to be fitted.
16+
#' @param recipe Optional, depending on the interface (see Details
17+
#' below). An object of class [recipes::recipe()]. Note: when
18+
#' needed, a \emph{named argument} should be used.
19+
#' @param x Optional, depending on the interface (see Details
20+
#' below). Can be data frame or matrix of predictors. Note: when
21+
#' needed, a \emph{named argument} should be used.
22+
#' @param y Optional, depending on the interface (see Details
23+
#' below). Can be a vector, data frame or matrix of predictors (the
24+
#' latter two in case of multivariate outcomes). Note: when needed,
25+
#' a \emph{named argument} should be used.
26+
#' @param data Optional, depending on the interface (see Details
27+
#' below). A data frame containing all relevant variables (e.g.
28+
#' outcome(s), predictors, case weights, etc). Note: when needed, a
29+
#' \emph{named argument} should be used.
1530
#' @param engine A character string for the software that should
1631
#' be used to fit the model. This is highly dependent on the type
1732
#' of model (e.g. linear regression, random forest, etc.).

man/fit.Rd

Lines changed: 21 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)