Transform rtable
to a list of matrices which can be used for outputting
Source: R/rlistings.R
matrix_form-listing_df-method.Rd
Although rtable
s 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 class '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 (aMatrixPrintForm
object).- indent_rownames
(
flag
)
silently ignored, as listings do not have row names nor indenting structure.- expand_newlines
(
flag
)
this should always beTRUE
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 byfont_spec()
.- col_gap
(
numeric(1)
)
the gap to be assumed between columns, in number of spaces with font specified byfontspec
.
Value
a formatters::MatrixPrintForm object.
Examples
lsting <- as_listing(mtcars)
mf <- matrix_form(lsting)