model_get_terms: Get the terms of a model

In broom.helpers: Helpers for Model Coefficients Tibbles

Get the terms of a model

Description

Return the result of stats::terms() applied to the model or NULL if it is not possible to get terms from model.

Usage

model_get_terms(model)

## Default S3 method:
model_get_terms(model)

## S3 method for class 'brmsfit'
model_get_terms(model)

## S3 method for class 'glmmTMB'
model_get_terms(model)

## S3 method for class 'model_fit'
model_get_terms(model)

## S3 method for class 'betareg'
model_get_terms(model)

## S3 method for class 'betareg'
model_get_terms(model)

## S3 method for class 'cch'
model_get_terms(model)

## S3 method for class 'fixest'
model_get_terms(model)

Arguments

model

(a model object, e.g. glm) A model object.

Details

For models fitted with glmmTMB::glmmTMB(), it will return a terms object taking into account all components ("cond" and "zi"). For a more restricted terms object, please refer to glmmTMB::terms.glmmTMB().

For fixest models, return a term object combining main variables and instrumental variables.

See Also

stats::terms()

Other model_helpers: model_compute_terms_contributions(), model_get_assign(), model_get_coefficients_type(), model_get_contrasts(), model_get_model(), model_get_model_frame(), model_get_model_matrix(), model_get_n(), model_get_nlevels(), model_get_offset(), model_get_pairwise_contrasts(), model_get_response(), model_get_response_variable(), model_get_weights(), model_get_xlevels(), model_identify_variables(), model_list_contrasts(), model_list_higher_order_variables(), model_list_terms_levels(), model_list_variables()

Examples

lm(hp ~ mpg + factor(cyl), mtcars) |>
  model_get_terms()

broom.helpers documentation built on April 12, 2025, 2:26 a.m.