View source: R/mlogittidiers.R
augment.mlogit  R Documentation 
Augment accepts a model object and a dataset and adds
information about each observation in the dataset. Most commonly, this
includes predicted values in the .fitted
column, residuals in the
.resid
column, and standard errors for the fitted values in a .se.fit
column. New columns always begin with a .
prefix to avoid overwriting
columns in the original dataset.
Users may pass data to augment via either the data
argument or the
newdata
argument. If the user passes data to the data
argument,
it must be exactly the data that was used to fit the model
object. Pass datasets to newdata
to augment data that was not used
during model fitting. This still requires that at least all predictor
variable columns used to fit the model are present. If the original outcome
variable used to fit the model is not included in newdata
, then no
.resid
column will be included in the output.
Augment will often behave differently depending on whether data
or
newdata
is given. This is because there is often information
associated with training observations (such as influences or related)
measures that is not meaningfully defined for new observations.
For convenience, many augment methods provide default data
arguments,
so that augment(fit)
will return the augmented training data. In these
cases, augment tries to reconstruct the original data based on the model
object with varying degrees of success.
The augmented dataset is always returned as a tibble::tibble with the
same number of rows as the passed dataset. This means that the passed
data must be coercible to a tibble. If a predictor enters the model as part
of a matrix of covariates, such as when the model formula uses
splines::ns()
, stats::poly()
, or survival::Surv()
, it is represented
as a matrix column.
We are in the process of defining behaviors for models fit with various
na.action
arguments, but make no guarantees about behavior when data is
missing at this time.
## S3 method for class 'mlogit'
augment(x, data = x$model, ...)
x 
an object returned from 
data 
Not currently used 
... 
Additional arguments. Not used. Needed to match generic
signature only. Cautionary note: Misspelled arguments will be
absorbed in

At the moment this only works on the estimation dataset. Need to set it up to predict on another dataset.
A tibble::tibble()
with columns:
.fitted 
Fitted or predicted value. 
.probability 
Class probability of modal class. 
.resid 
The difference between observed and fitted values. 
augment()
Other mlogit tidiers:
glance.mlogit()
,
tidy.mlogit()
# load libraries for models and data
library(mlogit)
data("Fishing", package = "mlogit")
Fish < dfidx(Fishing, varying = 2:9, shape = "wide", choice = "mode")
# fit model
m < mlogit(mode ~ price + catch  income, data = Fish)
# summarize model fit with tidiers
tidy(m)
augment(m)
glance(m)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.