tidy_vgam: Tidy a 'vglm' or a 'vgam' model

In broom.helpers: Helpers for Model Coefficients Tibbles

Tidy a vglm or a vgam model

Description

A tidier for models generated with VGAM::vglm() or VGAM::vgam(). Term names will be updated to be consistent with generic models. The original term names are preserved in an "original_term" column. Depending on the model, additional column "group", "component" and/or "y.level" may be added to the results.

Usage

tidy_vgam(x, conf.int = TRUE, conf.level = 0.95, ...)

Arguments

x	(vglm or vgam) A VGAM::vglm() or a VGAM::vgam() model.
conf.int	(logical) Whether or not to include a confidence interval in the tidied output.
conf.level	(numeric) The confidence level to use for the confidence interval (between 0 ans 1).
...	Additional parameters passed to parameters::model_parameters().

See Also

Other custom_tieders: tidy_broom(), tidy_multgee(), tidy_parameters(), tidy_svy_vglm(), tidy_with_broom_or_parameters(), tidy_zeroinfl()

Examples

  library(VGAM)
  mod <- vglm(
    Species ~ Sepal.Length + Sepal.Width,
    family = multinomial(),
    data = iris
  )
  mod |> tidy_vgam(exponentiate = TRUE)
  mod <- vglm(
    Species ~ Sepal.Length + Sepal.Width,
    family = multinomial(parallel = TRUE),
    data = iris
  )
  mod |> tidy_vgam(exponentiate = TRUE)

broom.helpers documentation built on June 8, 2025, 12:40 p.m.