matrix_form-listing_df-method: Transform 'rtable' to a list of matrices which can be used...

In rlistings: Clinical Trial Style Data Readout Listings

Transform rtable to a list of matrices which can be used for outputting

Description

Although rtables are represented as a tree data structure when outputting the table to ASCII or HTML, it is useful to map the rtable to an in-between state with the formatted cells in a matrix form.

Usage

## S4 method for signature 'listing_df'
matrix_form(
  obj,
  indent_rownames = FALSE,
  expand_newlines = TRUE,
  fontspec = font_spec,
  col_gap = 3L
)

Arguments

obj	(ANY) object to be transformed into a ready-to-render form (a MatrixPrintForm object).
indent_rownames	(flag) silently ignored, as listings do not have row names nor indenting structure.
expand_newlines	(flag) this should always be TRUE for listings. We keep it for debugging reasons.
fontspec	(font_spec) a font_spec object specifying the font information to use for calculating string widths and heights, as returned by font_spec().
col_gap	(numeric(1)) the gap to be assumed between columns, in number of spaces with font specified by fontspec.

Value

a formatters::MatrixPrintForm object.

See Also

formatters::matrix_form()

Examples

lsting <- as_listing(mtcars)
mf <- matrix_form(lsting)

rlistings documentation built on June 22, 2024, 9:17 a.m.