marginaleffects
objectTidy a marginaleffects
object
# S3 method for marginaleffects
tidy(x, conf_level = NULL, ...)
A "tidy" data.frame
of summary statistics which conforms to the
broom
package specification.
An object produced by the marginaleffects
function.
numeric value between 0 and 1. Confidence level to use to build a confidence interval. The default NULL
uses the conf_level
value used in the original call to marginaleffects()
.
Additional arguments are passed to the predict()
method
supplied by the modeling package.These arguments are particularly useful
for mixed-effects or bayesian models (see the online vignettes on the
marginaleffects
website). Available arguments can vary from model to
model, depending on the range of supported arguments by each modeling
package. See the "Model-Specific Arguments" section of the
?marginaleffects
documentation for a non-exhaustive list of available
arguments.
The tidy
function calculates average marginal effects by taking the mean
of all the unit-level marginal effects computed by the marginaleffects
function.
The standard error of the average marginal effects is obtained by taking the mean of each column of the Jacobian. . Then, we use this "Jacobian at the mean" in the Delta method to obtained standard errors.
In Bayesian models (e.g., brms
), we compute Average Marginal
Effects by applying the mean function twice. First, we apply it to all
marginal effects for each posterior draw, thereby estimating one Average (or
Median) Marginal Effect per iteration of the MCMC chain. Second, we take
the mean
and quantile
function to the results of Step 1 to obtain the
Average (or Median) Marginal Effect and its associated interval.
Other summary:
glance.marginaleffects()
,
reexports
,
summary.comparisons()
,
summary.marginaleffects()
,
summary.marginalmeans()
,
summary.predictions()
,
tidy.comparisons()
,
tidy.deltamethod()
,
tidy.marginalmeans()
,
tidy.predictions()
mod <- lm(mpg ~ hp * wt + factor(gear), data = mtcars)
mfx <- marginaleffects(mod)
# average marginal effects
tidy(mfx)
Run the code above in your browser using DataLab