modelsummary (version 0.1.0)

extract: Extract and combine estimates and goodness-of-fit statistics from several statistical models.

Description

Extract and combine estimates and goodness-of-fit statistics from several statistical models.

Usage

extract(models, statistic = "std.error", statistic_override = NULL,
  conf_level = 0.95, coef_map = NULL, coef_omit = NULL,
  gof_map = modelsummary::gof_map, gof_omit = NULL, add_rows = NULL,
  stars = FALSE, fmt = "%.3f")

Arguments

models

a single model object or a (potentially named) list of models to summarize

statistic

string name of the statistic to include in parentheses below estimates. Must be either "conf.int", or one of the column names produced by the `broom::tidy` function. Typical values include: "std.error", "conf.int", "statistic", "p.value".

statistic_override

manually override the uncertainy estimates. This argument accepts three types of input:

• a function or list of functions of length(models) which produce variance-covariance matrices with row and column names equal to the names of your coefficient estimates. For example, `R` supplies the `vcov` function, and the `sandwich` package supplies `vcovHC`, `vcovHAC`, etc.

• a list of length(models) variance-covariance matrices with row and column names equal to the names of your coefficient estimates.

• a list of length(models) numeric vectors with names equal to the names of your coefficient estimates.

conf_level

confidence level to use for confidence intervals

coef_map

named character vector. Names refer to the original variable names. Values refer to the variable names that will appear in the table. Coefficients which are omitted from this vector will be omitted from the table. The table will be ordered in the same order as this vector.

coef_omit

string regular expression. Omits all matching coefficients from the table (using `stringr::str_detect`).

gof_map

data.frame with four columns: `raw`, `clean`, `fmt`, and `omit`. See `modelsummary::gof_map`

gof_omit

string regular expression. Omits all matching gof statistics from the table (using `stringr::str_detect`).

add_rows

list of character vectors, each of length equal to the number of models + 1.

stars

FALSE for no significance stars. TRUE for default significance stars (*=.1, **=.05, ***=.01). Named numeric vector for custom significance stars. For example, `c('*' = .1, '+' = .05)`

fmt

string which specifies how numeric values will be rounded. This string is passed to the `sprintf` function. '%.3f' will keep 3 digits after the decimal point with trailing zero. '%.5f' will keep 5 digits. '%.3e' will use exponential notation. See `?sprintf` for more options.

Value

tibble

Examples

# NOT RUN {
library(modelsummary)
data(trees)
models <- list()
models[['Bivariate']] <- lm(Girth ~ Height, data = trees)
models[['Multivariate']] <- lm(Girth ~ Height + Volume, data = trees)
extract(models)

# }