marginaleffects (version 0.5.0)

summary.marginaleffects: Summarize a marginaleffects object

Description

Summarize a marginaleffects object

Usage

# S3 method for marginaleffects
summary(object, conf_level = 0.95, by = NULL, ...)

Arguments

object

An object produced by the marginaleffects function

conf_level

numeric value between 0 and 1. Confidence level to use to build a confidence interval.

by

Character vector of variable names over which to compute group-averaged marginal effects.

...

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.

Value

Data frame of summary statistics for an object produced by the marginaleffects function

Examples

# NOT RUN {
mod <- lm(mpg ~ hp * wt + factor(gear), data = mtcars)
mfx <- marginaleffects(mod)

# average marginal effects
summary(mfx)

# average marginal effects by group
summary(mfx, by = "gear")
# }