Get or set variable labels in a data.frame
.
Source
These functions were taken from formatters package, to reduce the complexity of the dependency tree and rewritten.
Arguments
- x
(
data.frame
orDataFrame
) data object- fill
(
logical(1)
) specifying what to return if variable has no label- value
(
character
) vector of variable labels of length equal to number of columns inx
; if named, names must match variable names inx
and will be used as key to set labels; useNA
to remove label from variable- ...
name-value pairs, where name corresponds to a variable name in
x
and value is the new variable label; useNA
to remove label from variable
Value
For col_labels
, named character vector of variable labels, the names being the corresponding variable names.
If the label
attribute is missing, the vector elements will be
the variable names themselves if fill = TRUE
and NA
if fill = FALSE
.
For col_labels<-
and col_relabel
, copy of x
with variable labels modified.
Details
Variable labels can be stored as a label
attribute set on individual variables.
These functions get or set this attribute, either on all (col_labels
) or some variables (col_relabel
).
In previous versions of teal.data
labels were managed with get_labels()
.
This function is deprecated as of 0.4.0
, use col_labels
instead.
Examples
x <- iris
col_labels(x)
#> Sepal.Length Sepal.Width Petal.Length Petal.Width Species
#> NA NA NA NA NA
col_labels(x) <- paste("label for", names(iris))
col_labels(x)
#> Sepal.Length Sepal.Width Petal.Length
#> "label for Sepal.Length" "label for Sepal.Width" "label for Petal.Length"
#> Petal.Width Species
#> "label for Petal.Width" "label for Species"
y <- col_relabel(x, Sepal.Length = "Sepal Length of iris flower")
col_labels(y)
#> Sepal.Length Sepal.Width
#> "Sepal Length of iris flower" "label for Sepal.Width"
#> Petal.Length Petal.Width
#> "label for Petal.Length" "label for Petal.Width"
#> Species
#> "label for Species"