new_pillar_component {pillar}R Documentation

Components of a pillar

Description

new_pillar_component() constructs an object of class "pillar_component".

pillar_component() is a convenience helper that wraps the input in a list and extracts width and minimum width.

Usage

new_pillar_component(x, ..., width, min_width = NULL)

pillar_component(x)

Arguments

x

A bare list (for new_pillar_component()), or an object with width and minimum width attributes (for pillar_component()).

...

These dots are for future extensions and must be empty.

width, min_width

TBD

Details

Objects of class "pillar" are internally a named lists of their components. The default components are title (may be missing), type, and data. Each component is a "pillar_component".

This class captures contents that can be fitted in a rectangle. Each component consists of one or multiple cells that are aligned horizontally (with one space in between) when printed. Each cell has a maximum (i.e., desired) width and may have a minimum width if the contents are compressible. The component object stores the width of the cells as an attribute.

Examples

# TBD

[Package pillar version 1.5.0 Index]