Extract Value Labels for a Variable

Returns the named value-label vector for a single variable in a survey design object, or NULL if no value labels have been set.

Usage

extract_val_labels(x, var)

Arguments

x

A survey design object.

var

<data-masked> Variable name (bare, unquoted).

Value

A named vector (e.g., c(Male = 1L, Female = 2L)), or NULL.

See also

set_val_labels() to set value labels

Other metadata: extract_question_preface(), extract_var_label(), extract_var_note(), infer_question_prefaces(), set_question_preface(), set_question_prefaces(), set_val_labels(), set_value_labels(), set_var_label(), set_var_note(), set_variable_labels(), set_variable_notes(), survey_metadata(), survey_weighting_history()

Examples

# nhanes_2017 carries haven-style value labels auto-extracted by as_survey()
d <- as_survey(nhanes_2017, ids = sdmvpsu, weights = wtint2yr,
               strata = sdmvstra, nest = TRUE)
extract_val_labels(d, riagendr)   # c(Male = 1, Female = 2)
#> NULL