Extract Variable Labels

Returns variable labels for one or more variables in a survey design object or data frame.

Usage

extract_var_label(x, ..., format = "named_vector", fill = NULL)

Arguments

x

A survey design object or data.frame.

...

<data-masked> Variable names (bare, unquoted). If empty, metadata for all variables is returned.

format

character(1). Output format: "named_vector" (default), "list", or "data_frame".

fill

Scalar or NULL. How to handle variables with no label: NULL (default) omits them; NA_character_ includes them with NA.

Value

• "named_vector" (default): named character vector. Empty: character(0).

• "list": named list of character scalars. Empty: list().

• "data_frame": tibble with columns variable and label. Empty: zero-row tibble.

See also

set_var_label() to set a variable label

Other metadata: extract_metadata(), extract_missing_codes(), extract_question_preface(), extract_universe(), extract_val_labels(), extract_var_note(), infer_question_prefaces(), set_missing_codes(), set_question_preface(), set_universe(), set_val_labels(), set_var_label(), set_var_note(), survey_metadata(), survey_weighting_history()

Examples

d <- as_survey(nhanes_2017, ids = sdmvpsu, weights = wtint2yr,
               strata = sdmvstra, nest = TRUE)
extract_var_label(d)
#>                                    seqn                                 sdmvpsu 
#>            "Respondent sequence number"            "Masked variance pseudo-PSU" 
#>                                sdmvstra                                wtmec2yr 
#>        "Masked variance pseudo-stratum"    "Full sample 2 year MEC exam weight" 
#>                                wtint2yr                                ridstatr 
#>   "Full sample 2 year interview weight"          "Interview/Examination status" 
#>                                riagendr                                ridageyr 
#>                                "Gender"             "Age in years at screening" 
#>                                ridreth3                                indfmpir 
#>      "Race/Hispanic origin w/ NH Asian"     "Ratio of family income to poverty" 
#>                                dmdeduc2                                  bpxsy1 
#>          "Education level - Adults 20+"  "Systolic: Blood pres (1st rdg) mm Hg" 
#>                                  bpxdi1                                  bpxpls 
#> "Diastolic: Blood pres (1st rdg) mm Hg"     "60 sec. pulse (30 sec. pulse * 2)" 
extract_var_label(d, riagendr, ridageyr)
#>                    riagendr                    ridageyr 
#>                    "Gender" "Age in years at screening" 
extract_var_label(d, format = "data_frame")
#> # A tibble: 14 × 2
#>    variable label                                
#>    <chr>    <chr>                                
#>  1 seqn     Respondent sequence number           
#>  2 sdmvpsu  Masked variance pseudo-PSU           
#>  3 sdmvstra Masked variance pseudo-stratum       
#>  4 wtmec2yr Full sample 2 year MEC exam weight   
#>  5 wtint2yr Full sample 2 year interview weight  
#>  6 ridstatr Interview/Examination status         
#>  7 riagendr Gender                               
#>  8 ridageyr Age in years at screening            
#>  9 ridreth3 Race/Hispanic origin w/ NH Asian     
#> 10 indfmpir Ratio of family income to poverty    
#> 11 dmdeduc2 Education level - Adults 20+         
#> 12 bpxsy1   Systolic: Blood pres (1st rdg) mm Hg 
#> 13 bpxdi1   Diastolic: Blood pres (1st rdg) mm Hg
#> 14 bpxpls   60 sec. pulse (30 sec. pulse * 2)    
extract_var_label(d, fill = NA_character_)
#>                                    seqn                                 sdmvpsu 
#>            "Respondent sequence number"            "Masked variance pseudo-PSU" 
#>                                sdmvstra                                wtmec2yr 
#>        "Masked variance pseudo-stratum"    "Full sample 2 year MEC exam weight" 
#>                                wtint2yr                                ridstatr 
#>   "Full sample 2 year interview weight"          "Interview/Examination status" 
#>                                riagendr                                ridageyr 
#>                                "Gender"             "Age in years at screening" 
#>                                ridreth3                                indfmpir 
#>      "Race/Hispanic origin w/ NH Asian"     "Ratio of family income to poverty" 
#>                                dmdeduc2                                  bpxsy1 
#>          "Education level - Adults 20+"  "Systolic: Blood pres (1st rdg) mm Hg" 
#>                                  bpxdi1                                  bpxpls 
#> "Diastolic: Blood pres (1st rdg) mm Hg"     "60 sec. pulse (30 sec. pulse * 2)"