opts_tbl_df: Constructive options for tibbles

In constructive: Display Idiomatic Code to Construct Most R Objects

Constructive options for tibbles

Description

These options will be used on objects of class 'tbl_df', also known as tibbles.

Usage

opts_tbl_df(
  constructor = c("tibble", "tribble", "next", "list"),
  ...,
  trailing_comma = TRUE,
  justify = c("left", "right", "centre", "none"),
  recycle = TRUE
)

Arguments

constructor	String. Name of the function used to construct the object, see Details section.
...	Additional options used by user defined constructors through the opts object
trailing_comma	Boolean. Whether to leave a trailing comma at the end of the constructor call calls
justify	String. Justification for columns if constructor is "tribble"
recycle	Boolean. For the "tibble" constructor. Whether to recycle scalars to compress the output.

Details

Depending on constructor, we construct the object as follows:

• "tibble" (default): Wrap the column definitions in a tibble::tibble() call.

• "tribble" : We build the object using tibble::tribble() if possible, and fall back to tibble::tibble().

• "next" : Use the constructor for the next supported class. Call .class2() on the object to see in which order the methods will be tried.

• "list" : Use list() and treat the class as a regular attribute.

Value

An object of class <constructive_options/constructive_options_tbl_df>

constructive documentation built on April 3, 2025, 9:39 p.m.