Package: insight 1.1.0.15

Daniel Lüdecke

insight: Easy Access to Model Information for Various Model Objects

A tool to provide an easy, intuitive and consistent access to information contained in various R models, like model formulas, model terms, information about random effects, data that was used to fit the model or data from response variables. 'insight' mainly revolves around two types of functions: Functions that find (the names of) information, starting with 'find_', and functions that get the underlying data, starting with 'get_'. The package has a consistent syntax and works with many different model objects, where otherwise functions to access these information are missing.

Authors:Daniel Lüdecke [aut, cre], Dominique Makowski [aut, ctb], Indrajeet Patil [aut, ctb], Philip Waggoner [aut, ctb], Mattan S. Ben-Shachar [aut, ctb], Brenton M. Wiernik [aut, ctb], Vincent Arel-Bundock [aut, ctb], Etienne Bacher [aut, ctb], Alex Hayes [rev], Grant McDermott [ctb], Rémi Thériault [ctb], Alex Reinhart [ctb]

insight_1.1.0.15.tar.gz
insight_1.1.0.15.zip(r-4.5)insight_1.1.0.15.zip(r-4.4)insight_1.1.0.15.zip(r-4.3)
insight_1.1.0.15.tgz(r-4.5-any)insight_1.1.0.15.tgz(r-4.4-any)insight_1.1.0.15.tgz(r-4.3-any)
insight_1.1.0.15.tar.gz(r-4.5-noble)insight_1.1.0.15.tar.gz(r-4.4-noble)
insight_1.1.0.15.tgz(r-4.4-emscripten)insight_1.1.0.15.tgz(r-4.3-emscripten)
insight.pdf |insight.html✨
insight/json (API)
NEWS

# Install 'insight' in R:
install.packages('insight', repos = c('https://easystats.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/easystats/insight/issues

Pkgdown site:https://easystats.github.io

Datasets:
  • efc_insight - Sample dataset from the EFC Survey
  • fish - Sample data set for count models

On CRAN:

Conda:

easystatshacktoberfestinsightmodelsnamespredictorsrandom

17.38 score 412 stars 213 packages 568 scripts 175k downloads 6 mentions 122 exports 0 dependencies

Last updated 1 days agofrom:7441299048. Checks:7 OK, 2 NOTE. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKMar 24 2025
R-4.5-winOKMar 24 2025
R-4.5-macOKMar 24 2025
R-4.5-linuxOKMar 24 2025
R-4.4-winOKMar 24 2025
R-4.4-macOKMar 24 2025
R-4.4-linuxOKMar 24 2025
R-4.3-winNOTEMar 24 2025
R-4.3-macNOTEMar 24 2025

Exports:all_models_equalall_models_same_classapply_table_themebroom_columnscheck_if_installedclean_namesclean_parameterscolor_ifcolor_textcolor_themecolour_ifcolour_textcompact_charactercompact_listdisplaydownload_modeleasystats_columnsellipsis_infoexport_tablefind_algorithmfind_formulafind_interactionsfind_offsetfind_parametersfind_predictorsfind_randomfind_random_slopesfind_responsefind_smoothfind_statisticfind_termsfind_transformationfind_variablesfind_weightsformat_alertformat_bfformat_capitalizeformat_ciformat_errorformat_messageformat_numberformat_pformat_pdformat_percentformat_ropeformat_stringformat_tableformat_valueformat_warningformula_okget_auxiliaryget_callget_correlation_slope_interceptget_correlation_slopesget_dataget_datagridget_devianceget_dfget_dispersionget_familyget_interceptget_loglikelihoodget_loglikelihood_adjustmentget_modelmatrixget_parametersget_predictedget_predicted_ciget_predictorsget_priorsget_randomget_residualsget_responseget_sigmaget_statisticget_transformationget_varcovget_varianceget_variance_dispersionget_variance_distributionget_variance_fixedget_variance_interceptget_variance_randomget_variance_residualget_variance_slopeget_weightshas_intercepthas_single_valueis_convergedis_empty_objectis_gam_modelis_mixed_modelis_modelis_model_supportedis_multivariateis_nested_modelsis_nullmodelis_regression_modellink_functionlink_inverseloglikelihoodmodel_infomodel_namen_grouplevelsn_obsn_parametersn_uniquenull_modelobject_has_namesobject_has_rownamesprint_colorprint_colourprint_htmlprint_mdprint_parameterssafe_deparsesafe_deparse_symbolstandardize_column_orderstandardize_namessupported_modelstext_remove_backtickstrim_wsvalidate_argument

Dependencies:

Adding support for new model classes

Rendered fromnewmodels.Rmdusingknitr::rmarkdownon Mar 24 2025.

Last update: 2025-03-21
Started: 2025-03-18

Exporting tables with captions and footers

Rendered fromexport.Rmdusingknitr::rmarkdownon Mar 24 2025.

Last update: 2025-03-18
Started: 2021-10-22

Formatting, printing and exporting tables

Rendered fromdisplay.Rmdusingknitr::rmarkdownon Mar 24 2025.

Last update: 2023-09-23
Started: 2021-02-10

Getting Started with Accessing Model Information

Rendered frominsight.Rmdusingknitr::rmarkdownon Mar 24 2025.

Last update: 2024-05-30
Started: 2019-01-31

Readme and manuals

Help Manual

Help pageTopics
Checks if all objects are models of same classall_models_equal all_models_same_class
Data frame and Tables Pretty Formattingapply_table_theme export_table
Checking if needed package is installedcheck_if_installed
Get clean names of model termsclean_names clean_names.character
Get clean names of model parametersclean_parameters
Color-formatting for data columns based on conditioncolor_if colour_if
Remove empty strings from charactercompact_character
Remove empty elements from listscompact_list
Generic export of data frames into formatted tablesdisplay display.data.frame print_html print_html.data.frame print_md print_md.data.frame
Download circus modelsdownload_model
Easystats columnsbroom_columns easystats_columns
Sample dataset from the EFC Surveyefc_insight
Gather information about objects in ellipsis (dot dot dot)ellipsis_info ellipsis_info.default
Find sampling algorithm and optimizersfind_algorithm
Find model formulafind_formula find_formula.default find_formula.nestedLogit formula_ok
Find interaction terms from modelsfind_interactions
Find possible offset terms in a modelfind_offset
Find names of model parametersfind_parameters find_parameters.default
Find model parameters from models with special componentsfind_parameters.averaging
Find names of model parameters from marginal effects modelsfind_parameters.betamfx
Find names of model parameters from Bayesian modelsfind_parameters.BGGM find_parameters.brmsfit
Find model parameters from estimated marginal means objectsfind_parameters.emmGrid
Find names of model parameters from generalized additive modelsfind_parameters.gam find_parameters.gamlss
Find names of model parameters from mixed modelsfind_parameters.glmmTMB
Find names of model parameters from zero-inflated modelsfind_parameters.zeroinfl
Find names of model predictorsfind_predictors find_predictors.default
Find names of random effectsfind_random
Find names of random slopesfind_random_slopes
Find name of the response variablefind_response find_response.joint
Find smooth terms from a model objectfind_smooth
Find statistic for modelfind_statistic
Find all model termsfind_terms find_terms.default
Find possible transformation of model variablesfind_transformation find_transformation.default
Find names of all variablesfind_variables
Find names of model weightsfind_weights
Sample data set for count modelsfish
Bayes Factor formattingformat_bf
Capitalizes the first letter in a stringformat_capitalize
Confidence/Credible Interval (CI) Formattingformat_ci format_ci.numeric
Format messages and warningsformat_alert format_error format_message format_warning
Convert number to wordsformat_number
p-values formattingformat_p
Probability of direction (pd) formattingformat_pd
Percentage in ROPE formattingformat_rope
String Values Formattingformat_string format_string.character
Parameter table formattingformat_table
Numeric Values Formattingformat_percent format_value format_value.data.frame format_value.numeric
Get auxiliary parameters from modelsget_auxiliary get_dispersion get_dispersion.default
Get the model's function callget_call
Get the data that was used to fit the modelget_data get_data.afex_aov get_data.default get_data.glmmTMB get_data.rma
Create a reference gridget_datagrid get_datagrid.data.frame get_datagrid.default get_datagrid.factor get_datagrid.numeric
Extract a reference grid from objects created by '{emmeans}' and '{marginaleffects}'get_datagrid.emmGrid
Model Devianceget_deviance get_deviance.default
Extract degrees of freedomget_df get_df.default
A robust alternative to stats::familyget_family
Get the value at the interceptget_intercept
Log-Likelihood and Log-Likelihood correctionget_loglikelihood get_loglikelihood.lm get_loglikelihood_adjustment loglikelihood
Model Matrixget_modelmatrix
Get model parametersget_parameters get_parameters.default
Get model parameters from marginal effects modelsget_parameters.betamfx
Get model parameters from models with special componentsget_parameters.betareg
Get model parameters from Bayesian modelsget_parameters.BFBayesFactor get_parameters.BGGM get_parameters.brmsfit
Get model parameters from estimated marginal means objectsget_parameters.emmGrid
Get model parameters from generalized additive modelsget_parameters.gamm
Get model parameters from mixed modelsget_parameters.glmmTMB
Get model parameters from htest-objectsget_parameters.htest
Get model parameters from zero-inflated and hurdle modelsget_parameters.zeroinfl
Model predictions (robust) and their confidence intervalsget_predicted get_predicted.default get_predicted.gam get_predicted.lm get_predicted.lmerMod get_predicted.principal get_predicted.stanreg
Confidence intervals around predicted valuesget_predicted_ci get_predicted_ci.default
Get the data from model predictorsget_predictors
Get summary of priors used for a modelget_priors get_priors.brmsfit
Get the data from random effectsget_random
Extract model residualsget_residuals get_residuals.default
Get the values from the response variableget_response get_response.default get_response.nestedLogit
Get residual standard deviation from modelsget_sigma
Get statistic associated with estimatesget_statistic get_statistic.default get_statistic.emmGrid get_statistic.gee get_statistic.glmmTMB
Return function of transformed response variablesget_transformation
Get variance-covariance matrix from modelsget_varcov get_varcov.aov get_varcov.default get_varcov.glmgee get_varcov.hurdle get_varcov.mixor
Get variance components from random effects modelsget_correlation_slopes get_correlation_slope_intercept get_variance get_variance.glmmTMB get_variance.merMod get_variance_dispersion get_variance_distribution get_variance_fixed get_variance_intercept get_variance_random get_variance_residual get_variance_slope
Get the values from model weightsget_weights get_weights.default
Checks if model has an intercepthas_intercept
Convergence test for mixed effects modelsis_converged
Check if object is emptyis_empty_object
Checks if a model is a generalized additive modelis_gam_model
Checks if a model is a mixed effects modelis_mixed_model
Checks if an object is a regression model or statistical test objectis_model is_regression_model
Checks if a regression model object is supported by the insight packageis_model_supported supported_models
Checks if an object stems from a multivariate response modelis_multivariate
Checks whether a list of models are nested modelsis_nested_models
Checks if model is a null-model (intercept-only)is_nullmodel
Get link-function from model objectlink_function link_function.betamfx link_function.betareg link_function.DirichletRegModel link_function.gamlss
Get link-inverse function from model objectlink_inverse link_inverse.betamfx link_inverse.betareg link_inverse.DirichletRegModel link_inverse.gamlss
Access information from model objectsmodel_info model_info.default
Name the modelmodel_name model_name.default
Count number of random effect levels in a mixed modeln_grouplevels
Get number of observations from a modeln_obs n_obs.afex_aov n_obs.glm n_obs.stanmvreg n_obs.svyolr
Count number of parameters in a modeln_parameters n_parameters.default n_parameters.glmmTMB n_parameters.merMod
Compute intercept-only model for regression modelsnull_model null_model.default
Check names and rownamesobject_has_names object_has_rownames
Coloured console outputcolor_text color_theme colour_text print_color print_colour
Prepare summary statistics of model parameters for printingprint_parameters
Standardize column orderstandardize_column_order standardize_column_order.parameters_model
Standardize column namesstandardize_names standardize_names.parameters_model
Remove backticks from a stringtext_remove_backticks text_remove_backticks.data.frame
Small helper functionshas_single_value n_unique n_unique.default safe_deparse safe_deparse_symbol trim_ws trim_ws.data.frame
Validate arguments against a given set of optionsvalidate_argument