Create a categorical variable specification

Create a categorical variable specification

Usage

mock_spec_categorical(
  name,
  levels,
  proportions = NULL,
  rtype = "factor",
  missing_codes = character(0),
  missing_proportions = numeric(0),
  garbage_rules = list(),
  provenance = "direct",
  model_hint = "auto"
)

Arguments

name

Variable name.

levels

Character vector of valid levels or codes.

proportions

Optional probabilities aligned to levels.

rtype

R output type. Defaults to "factor".

missing_codes

Explicit missing-code values.

missing_proportions

Missing-code probabilities aligned to missing_codes.

garbage_rules

List of intentional invalid-value rules.

provenance

Provenance metadata.

model_hint

Backend hint.

Value

A mock_spec_variable object.

See also

mock_spec(), mock_categorical()

Other mock specification APIs: mock_spec(), mock_spec_continuous(), mock_spec_date(), mock_spec_from_recodeflow()

Examples

smoking <- mock_spec_categorical(
  "smoking",
  levels = c("never", "former", "current"),
  proportions = c(0.5, 0.3, 0.2),
  rtype = "character"
)