labels {relations}R Documentation

Labels from subsettable objects

Description

Creates “nice” labels from (vector-like) objects.

Usage

LABELS(x, max_width = NULL, dots = "...", unique = FALSE)
LABEL(x)

Arguments

x For LABELS, a vector of R objects (if the object is not a vector, it is converted to a list of length 1). For LABEL, an R object.
max_width Integer vector (recycled as needed) specifying the maximum label width for each component of x. If NULL, there is no limit, otherwise, the label will be truncated to max_width.
dots A character string appended to a truncated label. If NULL, nothing is appended.
unique Logical indicating whether make.unique should be called on the final result.

Value

A character vector of labels generated from the supplied object(s). LABELS first checks whether the vector has names and uses these if any; otherwise, LABEL is called for each element to generate a “short” representation.
LABEL is generic to allow user extensions. The current methods return the result of format if the argument is of length 1 (for objects of classes set and tuple: of length 5), and create a simple class information otherwise.

Examples

LABELS(list(1, "test", X = "1", 1:5))
LABELS(set(X = as.tuple(1:20), "test", list(list(list(1,2)))))
LABELS(set(pair(1,2), set("a", 2), as.tuple(1:10)))

[Package relations version 0.2-0 Index]