tidy.marginaleffects: Tidy a 'marginaleffects' object

Description Usage Arguments Details Value Examples

View source: R/tidy.R

Description

Tidy a marginaleffects object

Usage

1
2
## S3 method for class 'marginaleffects'
tidy(x, conf.int = TRUE, conf.level = 0.95, ...)

Arguments

x

An object produced by the marginaleffects function.

conf.int

Logical indicating whether or not to include a confidence interval.

conf.level

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 are pushed forward to predict().

Details

The tidy function calculates average marginal effects by taking the mean of all the unit-level marginal effects computed by the marginaleffects function.

Value

A "tidy" data.frame of summary statistics which conforms to the broom package specification.

Examples

1
2
3
mod <- lm(mpg ~ hp * wt + factor(gear), data = mtcars)
mfx <- marginaleffects(mod)
tidy(mfx)

marginaleffects documentation built on Oct. 19, 2021, 1:09 a.m.