# Easy Access to Model Information for Various Model Objects

## Documentation for package ‘insight’ version 0.8.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

A C D F G H I L M N P S

## -- A --

all_models_equal | Checks if all objects are models of same class
all_models_same_class | Checks if all objects are models of same class

## -- C --

clean_names | Get clean names of model terms
clean_parameters | Get clean names of model parameters
color_if | Color-formatting for data columns based on condition
colour_if | Color-formatting for data columns based on condition

## -- D --

download_model | Download circus models

## -- F --

find_algorithm | Find sampling algorithm and optimizers
find_formula | Find model formula
find_interactions | Find interaction terms from models
find_parameters | Find names of model parameters
find_parameters.bayesx | Find names of model parameters
find_parameters.BFBayesFactor | Find names of model parameters
find_parameters.brmsfit | Find names of model parameters
find_parameters.gam | Find names of model parameters
find_parameters.hurdle | Find names of model parameters
find_parameters.merMod | Find names of model parameters
find_parameters.sim.merMod | Find names of model parameters
find_parameters.stanreg | Find names of model parameters
find_parameters.zeroinfl | Find names of model parameters
find_predictors | Find names of model predictors
find_random | Find names of random effects
find_random_slopes | Find names of random slopes
find_response | Find name of the response variable
find_statistic | Find statistic for model
find_terms | Find all model terms
find_variables | Find names of all variables
find_weights | Find names of model weights
format_ci | Confidence/Credible Interval (CI) Formatting
format_table | Dataframe and Tables Pretty Formatting
format_value | Numeric Values Formatting

## -- G --

get_correlation_slope_intercept | Get variance components from random effects models
get_data | Get the data that was used to fit the model
get_data.brmsfit | Get the data that was used to fit the model
get_data.clmm | Get the data that was used to fit the model
get_data.gee | Get the data that was used to fit the model
get_data.glmmadmb | Get the data that was used to fit the model
get_data.glmmTMB | Get the data that was used to fit the model
get_data.hurdle | Get the data that was used to fit the model
get_data.lme | Get the data that was used to fit the model
get_data.MCMCglmm | Get the data that was used to fit the model
get_data.merMod | Get the data that was used to fit the model
get_data.mixed | Get the data that was used to fit the model
get_data.MixMod | Get the data that was used to fit the model
get_data.rlmerMod | Get the data that was used to fit the model
get_data.rqss | Get the data that was used to fit the model
get_data.stanreg | Get the data that was used to fit the model
get_parameters | Get model parameters
get_parameters.aovlist | Get model parameters
get_parameters.bayesx | Find names of model parameters
get_parameters.BBmm | Get model parameters
get_parameters.betareg | Get model parameters
get_parameters.BFBayesFactor | Get model parameters
get_parameters.brmsfit | Get model parameters
get_parameters.cgam | Get model parameters
get_parameters.clm2 | Get model parameters
get_parameters.coxme | Get model parameters
get_parameters.DirichletRegModel | Get model parameters
get_parameters.Gam | Get model parameters
get_parameters.gam | Get model parameters
get_parameters.gamm | Get model parameters
get_parameters.glimML | Get model parameters
get_parameters.glmmTMB | Get model parameters
get_parameters.lme | Get model parameters
get_parameters.MCMCglmm | Get model parameters
get_parameters.merMod | Get model parameters
get_parameters.mixed | Get model parameters
get_parameters.MixMod | Get model parameters
get_parameters.rqss | Get model parameters
get_parameters.sim.merMod | Get model parameters
get_parameters.stanmvreg | Get model parameters
get_parameters.stanreg | Get model parameters
get_parameters.vgam | Get model parameters
get_parameters.zeroinfl | Get model parameters
get_predictors | Get the data from model predictors
get_priors | Get summary of priors used for a model
get_random | Get the data from random effects
get_response | Get the values from the response variable
get_statistic | Get statistic associated with estimates
get_statistic.betareg | Get statistic associated with estimates
get_statistic.clm2 | Get statistic associated with estimates
get_statistic.default | Get statistic associated with estimates
get_statistic.DirichletRegModel | Get statistic associated with estimates
get_statistic.gee | Get statistic associated with estimates
get_statistic.glmmTMB | Get statistic associated with estimates
get_varcov | Get variance-covariance matrix from models
get_varcov.betareg | Get variance-covariance matrix from models
get_varcov.brmsfit | Get variance-covariance matrix from models
get_varcov.clm2 | Get variance-covariance matrix from models
get_varcov.DirichletRegModel | Get variance-covariance matrix from models
get_varcov.gamlss | Get variance-covariance matrix from models
get_varcov.glmmTMB | Get variance-covariance matrix from models
get_varcov.hurdle | Get variance-covariance matrix from models
get_varcov.MixMod | Get variance-covariance matrix from models
get_varcov.mixor | Get variance-covariance matrix from models
get_varcov.truncreg | Get variance-covariance matrix from models
get_variance | Get variance components from random effects models
get_variance_dispersion | Get variance components from random effects models
get_variance_distribution | Get variance components from random effects models
get_variance_fixed | Get variance components from random effects models
get_variance_intercept | Get variance components from random effects models
get_variance_random | Get variance components from random effects models
get_variance_residual | Get variance components from random effects models
get_variance_slope | Get variance components from random effects models
get_weights | Get the values from model weights

## -- H --

has_intercept | Checks if model has an intercept

## -- I --

is_model | Checks if an object is a regression model object
is_model_supported | Checks if an object is a regression model object supported in 'insight' package.
is_multivariate | Checks if an object stems from a multivariate response model
is_nullmodel | Checks if model is a null-model (intercept-only)

## -- L --

link_function | Get link-function from model object
link_function.betareg | Get link-function from model object
link_function.DirichletRegModel | Get link-function from model object
link_function.gamlss | Get link-function from model object
link_inverse | Get link-inverse function from model object
link_inverse.betareg | Get link-inverse function from model object
link_inverse.DirichletRegModel | Get link-inverse function from model object
link_inverse.gamlss | Get link-inverse function from model object

## -- M --

model_info | Access information from model objects

## -- N --

n_obs | Get number of observations from a model
n_obs.stanmvreg | Get number of observations from a model
n_obs.svyolr | Get number of observations from a model

## -- P --

print_color | Coloured console output
print_colour | Coloured console output
print_parameters | Prepare summary statistics of model parameters for printing

## -- S --

supported_models | Checks if an object is a regression model object supported in 'insight' package.