Skip to contents

Get the model matrix of a model

Source: R/model_get_model_matrix.R, R/model_get_terms.R
model_get_model_matrix.Rd

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

# Default S3 method
model_get_model_matrix(model, ...)

# S3 method for class 'multinom'
model_get_model_matrix(model, ...)

# S3 method for class 'clm'
model_get_model_matrix(model, ...)

# S3 method for class 'brmsfit'
model_get_model_matrix(model, ...)

# S3 method for class 'glmmTMB'
model_get_model_matrix(model, ...)

# S3 method for class 'plm'
model_get_model_matrix(model, ...)

# S3 method for class 'biglm'
model_get_model_matrix(model, ...)

# S3 method for class 'model_fit'
model_get_model_matrix(model, ...)

# S3 method for class 'fixest'
model_get_model_matrix(model, ...)

# S3 method for class 'LORgee'
model_get_model_matrix(model, ...)

# S3 method for class 'betareg'
model_get_model_matrix(model, ...)

# S3 method for class 'cch'
model_get_model_matrix(model, ...)

# S3 method for class 'cch'
model_get_terms(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.

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()
#>                   (Intercept)  mpg factor(cyl)6 factor(cyl)8
#> Mazda RX4                   1 21.0            1            0
#> Mazda RX4 Wag               1 21.0            1            0
#> Datsun 710                  1 22.8            0            0
#> Hornet 4 Drive              1 21.4            1            0
#> Hornet Sportabout           1 18.7            0            1
#> Valiant                     1 18.1            1            0