xpose.xtras (version 0.2.2)

set_var_levels: Set variable levels

Description

For variable types such as catcov, it can be convenient to define levels. This function provides a straightforward means to do so, consistent with tidy functions like <case_when>.

Several convenience functions are provided for common levels in <levelers>.

Usage

set_var_levels(
  xpdb,
  .problem = NULL,
  ...,
  .missing = "Other",
  .ordered = character(),
  .handle_missing = c("quiet", "warn", "error")
)

Value

<xp_xtras> object with updated levels

Arguments

xpdb

<xp_xtras> object

.problem

<numeric> Problem number to use. Uses the all problems if NULL

...

<list> of formulas or leveler functions, where the relevant variable is provided as the argument,

.missing

<character> Value to use for missing levels

.ordered

<character> Names of columns whose levels should be treated as an ordered factor (see base::factor), even when supplied as a plain formula list rather than via lvl_inord(). Columns leveled with lvl_inord() are already ordered by default and do not need to be listed here.

.handle_missing

<character> How to handle missing levels: "quiet", "warn", or "error"

Examples

set_var_levels(xpdb_x,
  SEX = lvl_sex(),
  MED1 = lvl_bin(),
  MED2 = c(
    0 ~ "n",
    1 ~ "y"
  )
)