insight (version 0.18.6)

get_statistic: Get statistic associated with estimates

Description

Returns the statistic (t, z, ...) for model estimates. In most cases, this is the related column from coef(summary()).

Usage

get_statistic(x, ...)
# S3 method for default
get_statistic(x, column_index = 3, verbose = TRUE, ...)
# S3 method for glmmTMB
get_statistic(
  x,
  component = c("all", "conditional", "zi", "zero_inflated", "dispersion"),
  ...
)
# S3 method for clm2
get_statistic(x, component = c("all", "conditional", "scale"), ...)
# S3 method for betamfx
get_statistic(
  x,
  component = c("all", "conditional", "precision", "marginal"),
  ...
)
# S3 method for logitmfx
get_statistic(x, component = c("all", "conditional", "marginal"), ...)
# S3 method for mjoint
get_statistic(x, component = c("all", "conditional", "survival"), ...)
# S3 method for emmGrid
get_statistic(x, ci = 0.95, adjust = "none", merge_parameters = FALSE, ...)
# S3 method for gee
get_statistic(x, robust = FALSE, ...)
# S3 method for betareg
get_statistic(x, component = c("all", "conditional", "precision"), ...)
# S3 method for DirichletRegModel
get_statistic(x, component = c("all", "conditional", "precision"), ...)

Value

A data frame with the model's parameter names and the related test statistic.

Arguments

x

A model.

...

Currently not used.

column_index

For model objects that have no defined get_statistic() method yet, the default method is called. This method tries to extract the statistic column from coef(summary()), where the index of the column that is being pulled is column_index. Defaults to 3, which is the default statistic column for most models' summary-output.

verbose

Toggle messages and warnings.

component

Should all parameters, parameters for the conditional model, or for the zero-inflated part of the model be returned? Applies to models with zero-inflated component. component may be one of "conditional", "zi", "zero-inflated" or "all" (default). For models with smooth terms, component = "smooth_terms" is also possible. May be abbreviated. Note that the conditional component is also called count or mean component, depending on the model.

ci

Confidence Interval (CI) level. Default to 0.95 (95%). Currently only applies to objects of class emmGrid.

adjust

Character value naming the method used to adjust p-values or confidence intervals. See ?emmeans::summary.emmGrid for details.

merge_parameters

Logical, if TRUE and x has multiple columns for parameter names (like emmGrid objects may have), these are merged into a single parameter column, with parameters names and values as values.

robust

Logical, if TRUE, test statistic based on robust standard errors is returned.

Examples

data(mtcars)
m <- lm(mpg ~ wt + cyl + vs, data = mtcars)
get_statistic(m)