tidy.comparisons: Tidy a 'comparisons' object

View source: R/tidy.comparisons.R

tidy.comparisonsR Documentation

Tidy a comparisons object

Description

Calculate average contrasts by taking the mean of all the unit-level contrasts computed by the predictions function.

Usage

## S3 method for class 'comparisons'
tidy(x, conf_level = NULL, transform_avg = NULL, ...)

Arguments

x

An object produced by the comparisons function.

conf_level

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 comparisons().

transform_avg

A function applied to the estimates and confidence intervals after the unit-level estimates have been averaged.

...

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.

Details

To compute standard errors around the average marginaleffects, we begin by applying the mean function to each column of the Jacobian. Then, we use this matrix 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 calculate the mean and the quantile function to the results of Step 1 to obtain the Average Marginal Effect and its associated interval.

Value

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

See Also

Other summary: glance.marginaleffects(), reexports, summary.comparisons(), summary.marginaleffects(), summary.marginalmeans(), summary.predictions(), tidy.deltamethod(), tidy.marginaleffects(), tidy.marginalmeans(), tidy.predictions()

Examples

mod <- lm(mpg ~ factor(gear), data = mtcars)
contr <- comparisons(mod, variables = list(gear = "sequential"))
tidy(contr)

marginaleffects documentation built on Nov. 24, 2022, 1:06 a.m.