R: Retrieve values of labelled variables

get_values {sjlabelled} | R Documentation

## Retrieve values of labelled variables

### Description

This function retrieves the values associated with value labels from `labelled` vectors. Data is also labelled when imported from SPSS, SAS or STATA via `read_spss`, `read_sas` or `read_stata`.

### Usage

    get_values(x, sort.val = TRUE, drop.na = FALSE)

### Arguments

`x` | Variable (vector) with value label attributes; or a data frame or list with such variables.
`sort.val` | Logical, if `TRUE` (default), values of associated value labels are sorted.
`drop.na` | Logical, if `TRUE`, tagged NA values are excluded from the return value. See 'Examples' and `get_na`.

### Details

`labelled` vectors are numeric by default (when imported with read-functions like `read_spss`) and have variable and value labels attributes. The value labels are associated with the values from the labelled vector. This function returns the values associated with the vector's value labels, which may differ from actual values in the vector (e.g. if not all values have a related label).

### Value

The values associated with value labels from `x`, or `NULL` if `x` has no label attributes.

### See Also

`get_labels` for getting value labels and `get_na` to get values for missing values.

### Examples

    data(efc)
    str(efc$e42dep)
    get_values(efc$e42dep)
    get_labels(efc$e42dep)

    library(haven)
    x <- labelled(c(1:3, tagged_na("a", "c", "z"), 4:1),
                  c("Agreement" = 1, "Disagreement" = 4, "First" = tagged_na("c"),
                    "Refused" = tagged_na("a"), "Not home" = tagged_na("z")))
    # get all values
    get_values(x)
    # drop NA
    get_values(x, drop.na = TRUE)

    # data frame as input
    y <- labelled(c(2:3, 3:1, tagged_na("y"), 4:1),
                  c("Agreement" = 1, "Disagreement" = 4, "Why" = tagged_na("y")))
    get_values(data.frame(x, y))

[Package sjlabelled version 1.0.11 Index]