Skip to contents

Get the model frame of a model

Source: R/model_get_model_frame.R
model_get_model_frame.Rd

The structure of the object returned by stats::model.frame() could slightly differ for certain types of models. model_get_model_frame() will always return an object with the same data structure or NULL if it is not possible to compute model frame from model.

Usage

model_get_model_frame(model)

# Default S3 method
model_get_model_frame(model)

# S3 method for class 'coxph'
model_get_model_frame(model)

# S3 method for class 'svycoxph'
model_get_model_frame(model)

# S3 method for class 'survreg'
model_get_model_frame(model)

# S3 method for class 'biglm'
model_get_model_frame(model)

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

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

# S3 method for class 'svy_vglm'
model_get_model_frame(model)

Arguments

model

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

See also

stats::model.frame()

Other model_helpers: model_compute_terms_contributions(), model_get_assign(), model_get_coefficients_type(), model_get_contrasts(), model_get_model(), 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_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_frame() |>
  head()
#>                    hp  mpg factor(cyl)
#> Mazda RX4         110 21.0           6
#> Mazda RX4 Wag     110 21.0           6
#> Datsun 710         93 22.8           4
#> Hornet 4 Drive    110 21.4           6
#> Hornet Sportabout 175 18.7           8
#> Valiant           105 18.1           6