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
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
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
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
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. At this time, tibbles do not
support matrix-columns. This means you should not specify a matrix
of covariates in a model formula during the original model fitting
process, and that
survival::Surv() objects are not supported in input data. If you
encounter errors, try explicitly passing a tibble, or fitting the original
model on data in a tibble.
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 Mclust augment(x, data = NULL, ...)
A base::data.frame or
Additional arguments. Not used. Needed to match generic
signature only. Cautionary note: Misspelled arguments will be
tibble::tibble() with columns:
The uncertainty associated with the classification. Equal to one minus the model class probability.
#> #>#>#> #>#>#> #>#>#>set.seed(27) centers <- tibble::tibble( cluster = factor(1:3), num_points = c(100, 150, 50), # number points in each cluster x1 = c(5, 0, -3), # x1 coordinate of cluster center x2 = c(-1, 1, -2) # x2 coordinate of cluster center ) points <- centers %>% mutate( x1 = purrr::map2(num_points, x1, rnorm), x2 = purrr::map2(num_points, x2, rnorm) ) %>% dplyr::select(-num_points, -cluster) %>% tidyr::unnest(c(x1, x2)) m <- mclust::Mclust(points) tidy(m)#> # A tibble: 3 x 6 #> component size proportion variance mean.x1 mean.x2 #> <int> <int> <dbl> <dbl> <dbl> <dbl> #> 1 1 101 0.335 1.12 5.01 -1.04 #> 2 2 150 0.503 1.12 0.0594 1.00 #> 3 3 49 0.161 1.12 -3.20 -2.06augment(m, points)#> # A tibble: 300 x 4 #> x1 x2 .class .uncertainty #> <dbl> <dbl> <fct> <dbl> #> 1 6.91 -2.74 1 3.98e-11 #> 2 6.14 -2.45 1 1.99e- 9 #> 3 4.24 -0.946 1 1.47e- 4 #> 4 3.54 0.287 1 2.94e- 2 #> 5 3.91 0.408 1 7.48e- 3 #> 6 5.30 -1.58 1 4.22e- 7 #> 7 5.01 -1.77 1 1.06e- 6 #> 8 6.16 -1.68 1 7.64e- 9 #> 9 7.13 -2.17 1 4.16e-11 #> 10 5.24 -2.42 1 1.16e- 7 #> # … with 290 more rowsglance(m)#> # A tibble: 1 x 7 #> model G BIC logLik df hypvol nobs #> <chr> <int> <dbl> <dbl> <dbl> <dbl> <int> #> 1 EII 3 -2402. -1175. 9 NA 300