fit.Rd
fit()
and fit_xy()
take a model specification, translate the required
code by substituting arguments, and execute the model fit
routine.
# S3 method for model_spec fit(object, formula = NULL, data = NULL, control = fit_control(), ...) # S3 method for model_spec fit_xy(object, x = NULL, y = NULL, control = fit_control(), ...)
object | An object of class |
---|---|
formula | An object of class "formula" (or one that can be coerced to that class): a symbolic description of the model to be fitted. |
data | Optional, depending on the interface (see Details below). A data frame containing all relevant variables (e.g. outcome(s), predictors, case weights, etc). Note: when needed, a named argument should be used. |
control | A named list with elements |
... | Not currently used; values passed here will be
ignored. Other options required to fit the model should be
passed using |
x | A matrix or data frame of predictors. |
y | A vector, matrix or data frame of outcome data. |
A model_fit
object that contains several elements:
lvl
: If the outcome is a factor, this contains
the factor levels at the time of model fitting.
spec
: The model specification object
(object
in the call to fit
)
fit
: when the model is executed without error,
this is the model object. Otherwise, it is a try-error
object with the error message.
preproc
: any objects needed to convert between
a formula and non-formula interface (such as the terms
object)
The return value will also have a class related to the fitted model (e.g.
"_glm"
) before the base class of "model_fit"
.
fit()
and fit_xy()
substitute the current arguments in the model
specification into the computational engine's code, checks them
for validity, then fits the model using the data and the
engine-specific code. Different model functions have different
interfaces (e.g. formula or x
/y
) and these functions translate
between the interface used when fit()
or fit_xy()
were invoked and the one
required by the underlying model.
When possible, these functions attempt to avoid making copies of the
data. For example, if the underlying model uses a formula and
fit()
is invoked, the original data are references
when the model is fit. However, if the underlying model uses
something else, such as x
/y
, the formula is evaluated and
the data are converted to the required format. In this case, any
calls in the resulting model objects reference the temporary
objects used to fit the model.
set_engine()
, fit_control()
, model_spec
, model_fit
# Although `glm()` only has a formula interface, different # methods for specifying the model can be used library(dplyr)#> #>#>#> #>#>#> #>#>#> #>data("lending_club") lr_mod <- logistic_reg() lr_mod <- logistic_reg() using_formula <- lr_mod %>% set_engine("glm") %>% fit(Class ~ funded_amnt + int_rate, data = lending_club) using_xy <- lr_mod %>% set_engine("glm") %>% fit_xy(x = lending_club[, c("funded_amnt", "int_rate")], y = lending_club$Class) using_formula#> parsnip model object #> #> #> Call: stats::glm(formula = formula, family = stats::binomial, data = data) #> #> Coefficients: #> (Intercept) funded_amnt int_rate #> 5.131e+00 2.767e-06 -1.586e-01 #> #> Degrees of Freedom: 9856 Total (i.e. Null); 9854 Residual #> Null Deviance: 4055 #> Residual Deviance: 3698 AIC: 3704using_xy#> parsnip model object #> #> #> Call: stats::glm(formula = formula, family = stats::binomial, data = data) #> #> Coefficients: #> (Intercept) funded_amnt int_rate #> 5.131e+00 2.767e-06 -1.586e-01 #> #> Degrees of Freedom: 9856 Total (i.e. Null); 9854 Residual #> Null Deviance: 4055 #> Residual Deviance: 3698 AIC: 3704