Assigns a label to a vector or data frame, or returns value stored
in the object's label attribute (or NA if none exists).
Usage
label(x, all = FALSE, fallback = FALSE, simplify = FALSE)
label(x) <- value
llabel(x, all = TRUE, fallback = FALSE, simplify = FALSE)Arguments
- x
An R object to extract labels from.
- all
Logical. When x is a data frame, setting this argument to
TRUEwill make the function return all variable labels. By default, its value isFALSE, so that if x is a data frame, it is the data frame's label itself that will be returned.- fallback
a logical value indicating if labels (returned values) should fallback to object name(s). Defaults to
FALSE.- simplify
When x is a data frame and
all = TRUE, coerce results to a vector and removeNA's. Default isFALSE.- value
String to be used as label. To clear existing labels, use
NAorNULL.
Value
A single character vector if all = FALSE (default),
or a named list if all = TRUE (named vector when using
simplify = TRUE.
Details
The wrapper function llabel was named that way to avoid conflicting
with base function labels.
Note
Loosely based on Gergely Daróczi's label
function.
Author
Dominic Comtois, dominic.comtois@gmail.com,