R: Get Variable Label

label {rapportools} | R Documentation

## Get Variable Label

### Description

This function returns character value previously stored in variable's `label` attribute. If none found, and `fallback` argument is set to `TRUE` (default), the function returns object's name (retrieved by `deparse(substitute(x))`), otherwise `NA` is returned with a warning notice.

### Usage

    label(x, fallback = TRUE, simplify = TRUE)

### Arguments

`x` | an R object to extract labels from
`fallback` | a logical value indicating if labels should fallback to object name(s)
`simplify` | coerce results to a vector (`TRUE` by default), otherwise, a `list` is returned

### Value

a character vector with variable's label(s)

### Examples

    ## Not run:
    x <- rnorm(100)
    label(x)         # returns "x"
    label(x, FALSE)  # returns NA and issues a warning

    label(mtcars$hp) <- "Horsepower"
    label(mtcars)         # returns "Horsepower" instead of "hp"
    label(mtcars, FALSE)  # returns NA where no labels are found
    label(sleep, FALSE)   # returns NA for each variable and issues a warning

    ## End(Not run)

[Package rapportools version 1.0 Index]