broom.helpers (version 1.19.0)

model_get_model_matrix: Get the model matrix of a model

Description

The structure of the object returned by stats::model.matrix() could slightly differ for certain types of models. model_get_model_matrix() will always return an object with the same structure as stats::model.matrix.default().

Usage

model_get_model_matrix(model, ...)
# S3 method for default
model_get_model_matrix(model, ...)
# S3 method for multinom
model_get_model_matrix(model, ...)
# S3 method for clm
model_get_model_matrix(model, ...)
# S3 method for brmsfit
model_get_model_matrix(model, ...)
# S3 method for glmmTMB
model_get_model_matrix(model, ...)
# S3 method for plm
model_get_model_matrix(model, ...)
# S3 method for biglm
model_get_model_matrix(model, ...)
# S3 method for model_fit
model_get_model_matrix(model, ...)
# S3 method for fixest
model_get_model_matrix(model, ...)
# S3 method for LORgee
model_get_model_matrix(model, ...)
# S3 method for betareg
model_get_model_matrix(model, ...)
# S3 method for cch
model_get_model_matrix(model, ...)

Arguments

model

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

...

Additional arguments passed to stats::model.matrix().

Details

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

For plm::plm() models, constant columns are not removed.

For fixest models, will recreate a model matrix with both main variables and instrumental variables. For more options, see fixest::model.matrix.fixest.

See Also

stats::model.matrix()

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_n(), model_get_nlevels(), model_get_offset(), model_get_pairwise_contrasts(), model_get_response(), model_get_response_variable(), model_get_terms(), 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_model_matrix() |>
  head()