get_val_labs {labelr}

Return Look-up Table of Variable Values and Value Labels

Description

For a data.frame with value-labeled variables, get_val_labs returns a derivative data.frame that shows the value-to-label mapping for each unique value of each value-labeled variable.

Usage

get_val_labs(data, var = NULL)

gvl(data, var = NULL)

Arguments

data

a data.frame.

var

a character vector with the name(s) of any specific variable(s) (If NULL, returned data.frame will contain all variable value labels).

Details

Note 1: get_val_labs returns a data.frame that is intended strictly to facilitate human-in-the-loop –visual– display and inspection of what (if any) value label has been associated with each variable value. It is –not– intended for use in automated querying or subsetting or as an indicator of of the supplied data.frame's columns' underlying classes or atomic types. In particular, all columns of the –returned– data.frame object are coerced to character for display purposes, as a result of concatenating value information from different variables of potentially different atomic types or classes. For example, all elements of the "vals" column are expressed as character even if the underlying values themselves are numeric.

Note 2: gvl is a compact alias for get_val_labs: they do the same thing, and the former is easier to type

Value

A three-column data.frame, consisting of "var", "vals", and "labs" columns, where each row corresponds to a unique value of a value-labeled variable (column) from the user-supplied data.frame OR – for variables labeled using add_quant_labs (or add_quant1) – the upper bound of numerical values that fall within that label's range of coverage. Note that all variables of the returned data.frame are coerced to character (see Note 1 of details).

Examples

# add val labs to multiple variables at once
# make a "Likert"-type fake data set to demo
# note, by default, add_val_labs() "vars" arg will do partial matching
# in this case, we catch all vars with "x" in their name
set.seed(272)
dflik <- make_likert_data(scale = 1:7)
vals2label <- 1:7
labs2use <- c(
  "VSD",
  "SD",
  "D",
  "N",
  "A",
  "SA",
  "VSA"
)

dflik <- add_val_labs(
  data = dflik, vars = c("x", "y3"), # note the vars args
  vals = vals2label,
  labs = labs2use,
  partial = TRUE
)

# note, all "x" vars get the labs, as does "y3"
get_val_labs(dflik)
get_val_labs(dflik, "x1")