R: Label, Unit Attribute of an Object

Label, Unit {DescTools} | R Documentation

## Label, Unit Attribute of an Object

### Description

Set and retrieve the `label`, resp. `unit` attribute of `x`. This can be helpful for documenting the specific meaning of a variable, of an entire data.frame or any other object. For single vectors it can be useful to store the unit.

### Usage

    Label(x)
    Label(x) <- value

    Unit(x)
    Unit(x) <- value

### Arguments

`x` | any object
`value` | a single string describing the object

### Details

The label should consist of a single text (length of 1). The text may contain line feeds. It can be deleted by setting the label to `NULL`.

### Value

`Label` and `Unit` return the label attribute of x, if any; otherwise, NULL.

### Author(s)

Andri Signorell <andri@signorell.net>

### See Also

A more elaborated label version can be found in package Hmisc `label()`.

### Examples

    # add a descriptive label to a variable
    Label(d.diamonds$colour) <- "The rating scale applied to diamonds ranges from colorless
    to yellow, as any other color is extremely rare."

    # technically just appending the text as attribute to the variable
    attributes(d.diamonds$colour)

    # label is supported while describing data
    Desc(d.diamonds$colour)

    # The label can be deleted by setting it to NULL
    Label(d.diamonds$colour) <- NULL

    # Labelling the columns of a data.frame is best done with a loop
    # (all so far seen *apply aproaches lead to more complicated code...)
    lbl <-  RndWord(16, 7)
    for(i in seq_along(lbl))
      Label(d.pizza[, i]) <- lbl[i]

    Str(d.pizza)

[Package DescTools version 0.99.26 Index]