parameters (version 0.4.0)

standardize_names: Standardize column names

Description

Standardize column names from data frames, in particular objects returned from model_parameters(), so column names are consistent and the same for any model object.

Usage

standardize_names(data, ...)
# S3 method for parameters_model
standardize_names(data, style = c("easystats", "broom"), ...)

Arguments

data

A data frame. Currently, only objects from model_parameters() are accepted.

...

Currently not used.

style

Standardization can either be based on the naming conventions from the easystats project, or on broom's naming scheme.

Value

A data frame, with standardized column names.

Details

This method is in particular useful for package developers or users who use model_parameters() in their own code or functions to retrieve model parameters for further processing. As model_parameters() returns a data frame with varying column names (depending on the input), accessing the required information is probably not quite straightforward. In such cases, standardize_names() can be used to get consistent, i.e. always the same column names, no matter what kind of model was used in model_parameters().

For style = "broom", column names are renamed to match broom's naming scheme, i.e. Parameter is renamed to term, Coefficient becomes estimate and so on.

Examples

# NOT RUN {
library(parameters)
model <- lm(mpg ~ wt + cyl, data = mtcars)
mp <- model_parameters(model)

as.data.frame(mp)
standardize_names(mp)
standardize_names(mp, style = "broom")
# }