insight: get_statistic – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

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, ...)

## Default S3 method:
get_statistic(x, column_index = 3, verbose = TRUE, ...)

## S3 method for class 'glmmTMB'
get_statistic(
  x,
  component = c("all", "conditional", "zi", "zero_inflated", "dispersion"),
  ...
)

## S3 method for class 'clm2'
get_statistic(x, component = c("all", "conditional", "scale"), ...)

## S3 method for class 'betamfx'
get_statistic(
  x,
  component = c("all", "conditional", "precision", "marginal"),
  ...
)

## S3 method for class 'logitmfx'
get_statistic(x, component = c("all", "conditional", "marginal"), ...)

## S3 method for class 'mjoint'
get_statistic(x, component = c("all", "conditional", "survival"), ...)

## S3 method for class 'emmGrid'
get_statistic(x, ci = 0.95, adjust = "none", merge_parameters = FALSE, ...)

## S3 method for class 'gee'
get_statistic(x, robust = FALSE, ...)

## S3 method for class 'betareg'
get_statistic(x, component = c("all", "conditional", "precision"), ...)

## S3 method for class 'DirichletRegModel'
get_statistic(x, component = c("all", "conditional", "precision"), ...)

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.

Value

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

Examples

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

insight

Easy Access to Model Information for Various Model Objects

v0.14.0

GPL-3

Authors

Daniel Lüdecke [aut, cre] (<https://orcid.org/0000-0002-8895-3206>, @strengejacke), Dominique Makowski [aut, ctb] (<https://orcid.org/0000-0001-5375-9967>, @Dom_Makowski), Indrajeet Patil [aut, ctb] (<https://orcid.org/0000-0003-1995-6531>, @patilindrajeets), Philip Waggoner [aut, ctb] (<https://orcid.org/0000-0002-7825-7573>), Mattan S. Ben-Shachar [aut, ctb] (<https://orcid.org/0000-0002-4287-4801>), Brenton M. Wiernik [aut] (<https://orcid.org/0000-0001-9560-6336>, @bmwiernik)

Initial release