tidy_add_variable_labels: Add variable labels

In broom.helpers: Helpers for Model Coefficients Tibbles

Add variable labels

Description

Will add variable labels in a var_label column, based on:

1. labels provided in labels argument if provided;

2. variable labels defined in the original data frame with the label attribute (cf. labelled::var_label());

3. variable name otherwise.

Usage

tidy_add_variable_labels(
  x,
  labels = NULL,
  interaction_sep = " * ",
  instrumental_suffix = " (instrumental)",
  model = tidy_get_model(x)
)

Arguments

x	(data.frame) A tidy tibble as produced by ⁠tidy_*()⁠ functions.
labels	(formula-list-selector) An optional named list or a named vector of custom variable labels.
interaction_sep	(string) Separator for interaction terms.
instrumental_suffix	(string) Suffix added to variable labels for instrumental variables (fixest models). NULL to add nothing.
model	(a model object, e.g. glm) The corresponding model, if not attached to x.

Details

If the variable column is not yet available in x, tidy_identify_variables() will be automatically applied.

It is possible to pass a custom label for an interaction term in labels (see examples).

See Also

Other tidy_helpers: tidy_add_coefficients_type(), tidy_add_contrasts(), tidy_add_estimate_to_reference_rows(), tidy_add_header_rows(), tidy_add_n(), tidy_add_pairwise_contrasts(), tidy_add_reference_rows(), tidy_add_term_labels(), tidy_attach_model(), tidy_disambiguate_terms(), tidy_group_by(), tidy_identify_variables(), tidy_plus_plus(), tidy_remove_intercept(), tidy_select_variables()

Examples

df <- Titanic |>
  dplyr::as_tibble() |>
  dplyr::mutate(Survived = factor(Survived, c("No", "Yes"))) |>
  labelled::set_variable_labels(
    Class = "Passenger's class",
    Sex = "Sex"
  )

glm(Survived ~ Class * Age * Sex, data = df, weights = df$n, family = binomial) |>
  tidy_and_attach() |>
  tidy_add_variable_labels(
    labels = list(
      "(Intercept)" ~ "Custom intercept",
      Sex ~ "Gender",
      "Class:Age" ~ "Custom label"
    )
  )

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