pillar (version 1.4.6)

pillar: Format a vector suitable for tabular display

Description

pillar() formats a vector using one row for a title (if given), one row for the type, and length(x) rows for the data.

Usage

pillar(x, title = NULL, width = NULL, ...)

Arguments

x

A vector to format.

title

An optional title for the column. The title will be used "as is", no quoting will be applied.

width

Default width, optional.

...

Passed on to pillar_shaft().

Details

A pillar consists of a capital and a shaft.

The capital is constructed using the (currently internal) pillar_capital() function, which uses the title argument and calls type_sum() to format the type.

For the shaft, the pillar_shaft() generic is called with the object. The returned value is stored and processed with format() when displaying the pillar. The call to format() has a valid width argument. Depending on the implementation, the output representation can be computed eagerly right away (as done with new_pillar_shaft_simple()), or only when format() is called. The latter allows for adaptive shortening of the output depending on the available width, see pillar:::pillar_shaft.numeric for an example.

Examples

# NOT RUN {
x <- 123456789 * (10 ^ c(-1, -3, -5, NA, -8, -10))
pillar(x)
pillar(-x)
pillar(runif(10))
pillar(rcauchy(20))

# Special values are highlighted
pillar(c(runif(5), NA, NaN, Inf, -Inf))

# Very wide ranges will be displayed in scientific format
pillar(c(1e10, 1e-10), width = 20)
pillar(c(1e10, 1e-10))

x <- c(FALSE, NA, FALSE, FALSE, TRUE, FALSE, FALSE, TRUE, FALSE, TRUE)
pillar(x)

x <- c("This is string is rather long", NA, "?", "Short")
pillar(x)
pillar(x, width = 30)
pillar(x, width = 5)

date <- as.Date("2017-05-15")
pillar(date + c(1, NA, 3:5))
pillar(as.POSIXct(date) + c(30, NA, 600, 3600, 86400))
# }