R: Labelled vectors for SPSS

labelled_spss {haven} | R Documentation

## Labelled vectors for SPSS

### Description

This class is only used when `user_na = TRUE` in `read_sav()`. It is similar to the `labelled()` class but it also models SPSS's user-defined missings, which can be up to three distinct values, or for numeric vectors a range.

### Usage

    labelled_spss(x, labels, na_values = NULL, na_range = NULL,
      label = NULL)

### Arguments

`x` | A vector to label. Must be either numeric (integer or double) or character.
`labels` | A named vector or `NULL`. The vector should be the same type as `x`. Unlike factors, labels don't need to be exhaustive: only a fraction of the values might be labelled.
`na_values` | A vector of values that should also be considered as missing.
`na_range` | A numeric vector of length two giving the (inclusive) extents of the range. Use `-Inf` and `Inf` if you want the range to be open ended.
`label` | A short, human-readable description of the vector.

### Examples

    x1 <- labelled_spss(1:10, c(Good = 1, Bad = 8), na_values = c(9, 10))
    is.na(x1)

    x2 <- labelled_spss(1:10, c(Good = 1, Bad = 8), na_range = c(9, Inf),
                        label = "Quality rating")
    is.na(x2)

    # Print data and metadata
    x2

[Package haven version 2.1.1 Index]