Tidy summarizes information about the components of a model. A model component might be a single term in a regression, a single hypothesis, a cluster, or a class. Exactly what tidy considers to be a model component varies across models but is usually self-evident. If a model has several distinct types of components, you will need to specify which components to return.
# S3 method for margins
tidy(x, conf.int = FALSE, conf.level = 0.95, ...)
A margins
object returned from margins::margins()
.
Logical indicating whether or not to include a confidence
interval in the tidied output. Defaults to FALSE
.
The confidence level to use for the confidence interval
if conf.int = TRUE
. Must be strictly greater than 0 and less than 1.
Defaults to 0.95, which corresponds to a 95 percent confidence interval.
Additional arguments. Not used. Needed to match generic
signature only. Cautionary note: Misspelled arguments will be
absorbed in ...
, where they will be ignored. If the misspelled
argument has a default value, the default value will be used.
For example, if you pass conf.lvel = 0.9
, all computation will
proceed using conf.level = 0.95
. Additionally, if you pass
newdata = my_tibble
to an augment()
method that does not
accept a newdata
argument, it will use the default value for
the data
argument.
The margins
package provides a way to obtain coefficient marginal
effects for a variety of (non-linear) models, such as logit or models with
multiway interaction terms. Note that the glance.margins()
method
requires rerunning the underlying model again, which can take some time.
Similarly, an augment.margins()
method is not currently supported, but
users can simply run the underlying model to obtain the same information.
A tibble::tibble()
with columns:
Upper bound on the confidence interval for the estimate.
Lower bound on the confidence interval for the estimate.
The estimated value of the regression term.
The two-sided p-value associated with the observed statistic.
The value of a T-statistic to use in a hypothesis that the regression term is non-zero.
The standard error of the regression term.
The name of the regression term.
# feel free to ignore the following line—it allows {broom} to supply
# examples without requiring the model-supplying package to be installed.
if (requireNamespace("margins", quietly = TRUE)) {
# load libraries for models and data
library(margins)
# example 1: logit model
mod_log <- glm(am ~ cyl + hp + wt, data = mtcars, family = binomial)
# get tidied "naive" model coefficients
tidy(mod_log)
# convert to marginal effects with margins()
marg_log <- margins(mod_log)
# get tidied marginal effects
tidy(marg_log)
tidy(marg_log, conf.int = TRUE)
# requires running the underlying model again. quick for this example
glance(marg_log)
# augmenting `margins` outputs isn't supported, but
# you can get the same info by running on the underlying model
augment(mod_log)
# example 2: threeway interaction terms
mod_ie <- lm(mpg ~ wt * cyl * disp, data = mtcars)
# get tidied "naive" model coefficients
tidy(mod_ie)
# convert to marginal effects with margins()
marg_ie0 <- margins(mod_ie)
# get tidied marginal effects
tidy(marg_ie0)
glance(marg_ie0)
# marginal effects evaluated at specific values of a variable (here: cyl)
marg_ie1 <- margins(mod_ie, at = list(cyl = c(4,6,8)))
# summarize model fit with tidiers
tidy(marg_ie1)
# marginal effects of one interaction variable (here: wt), modulated at
# specific values of the two other interaction variables (here: cyl and drat)
marg_ie2 <- margins(mod_ie,
variables = "wt",
at = list(cyl = c(4,6,8), drat = c(3, 3.5, 4)))
# summarize model fit with tidiers
tidy(marg_ie2)
}
#> # A tibble: 18 × 7
#> term at.variable at.value estimate std.error statistic p.value
#> <chr> <chr> <dbl> <dbl> <dbl> <dbl> <dbl>
#> 1 wt cyl 4 7.91 5.06 1.56 0.118
#> 2 wt drat 3 7.91 5.06 1.56 0.118
#> 3 wt cyl 4 7.91 5.06 1.56 0.118
#> 4 wt drat 3.5 7.91 5.06 1.56 0.118
#> 5 wt cyl 4 7.91 5.06 1.56 0.118
#> 6 wt drat 4 7.91 5.06 1.56 0.118
#> 7 wt cyl 6 2.96 2.52 1.18 0.239
#> 8 wt drat 3 2.96 2.52 1.18 0.239
#> 9 wt cyl 6 2.96 2.52 1.18 0.239
#> 10 wt drat 3.5 2.96 2.52 1.18 0.239
#> 11 wt cyl 6 2.96 2.52 1.18 0.239
#> 12 wt drat 4 2.96 2.52 1.18 0.239
#> 13 wt cyl 8 -1.98 2.40 -0.825 0.409
#> 14 wt drat 3 -1.98 2.40 -0.825 0.409
#> 15 wt cyl 8 -1.98 2.40 -0.825 0.409
#> 16 wt drat 3.5 -1.98 2.40 -0.825 0.409
#> 17 wt cyl 8 -1.98 2.40 -0.825 0.409
#> 18 wt drat 4 -1.98 2.40 -0.825 0.409