obj_name,VNodeInfo-method | R Documentation |
formatters
packageSee the formatters
documentation for descriptions of these generics.
## S4 method for signature 'VNodeInfo'
obj_name(obj)
## S4 method for signature 'Split'
obj_name(obj)
## S4 replacement method for signature 'VNodeInfo'
obj_name(obj) <- value
## S4 replacement method for signature 'Split'
obj_name(obj) <- value
## S4 method for signature 'Split'
obj_label(obj)
## S4 method for signature 'TableRow'
obj_label(obj)
## S4 method for signature 'VTableTree'
obj_label(obj)
## S4 method for signature 'ValueWrapper'
obj_label(obj)
## S4 replacement method for signature 'Split'
obj_label(obj) <- value
## S4 replacement method for signature 'TableRow'
obj_label(obj) <- value
## S4 replacement method for signature 'ValueWrapper'
obj_label(obj) <- value
## S4 replacement method for signature 'VTableTree'
obj_label(obj) <- value
## S4 method for signature 'VTableNodeInfo'
obj_format(obj)
## S4 method for signature 'CellValue'
obj_format(obj)
## S4 method for signature 'Split'
obj_format(obj)
## S4 replacement method for signature 'VTableNodeInfo'
obj_format(obj) <- value
## S4 replacement method for signature 'Split'
obj_format(obj) <- value
## S4 replacement method for signature 'CellValue'
obj_format(obj) <- value
## S4 method for signature 'Split'
obj_na_str(obj)
## S4 method for signature 'VTitleFooter'
main_title(obj)
## S4 replacement method for signature 'VTitleFooter'
main_title(obj) <- value
## S4 method for signature 'TableRow'
main_title(obj)
## S4 method for signature 'VTitleFooter'
subtitles(obj)
## S4 replacement method for signature 'VTitleFooter'
subtitles(obj) <- value
## S4 method for signature 'TableRow'
subtitles(obj)
## S4 method for signature 'VTitleFooter'
main_footer(obj)
## S4 replacement method for signature 'VTitleFooter'
main_footer(obj) <- value
## S4 method for signature 'TableRow'
main_footer(obj)
## S4 method for signature 'VTitleFooter'
prov_footer(obj)
## S4 replacement method for signature 'VTitleFooter'
prov_footer(obj) <- value
## S4 method for signature 'TableRow'
prov_footer(obj)
## S4 method for signature 'VTableNodeInfo'
table_inset(obj)
## S4 method for signature 'PreDataTableLayouts'
table_inset(obj)
## S4 replacement method for signature 'VTableNodeInfo'
table_inset(obj) <- value
## S4 replacement method for signature 'PreDataTableLayouts'
table_inset(obj) <- value
## S4 replacement method for signature 'InstantiatedColumnInfo'
table_inset(obj) <- value
## S4 method for signature 'TableRow'
nlines(x, colwidths = NULL, max_width = NULL)
## S4 method for signature 'LabelRow'
nlines(x, colwidths = NULL, max_width = NULL)
## S4 method for signature 'RefFootnote'
nlines(x, colwidths = NULL, max_width = NULL)
## S4 method for signature 'InstantiatedColumnInfo'
nlines(x, colwidths = NULL, max_width = NULL)
## S4 method for signature 'VTableTree'
make_row_df(
tt,
colwidths = NULL,
visible_only = TRUE,
rownum = 0,
indent = 0L,
path = character(),
incontent = FALSE,
repr_ext = 0L,
repr_inds = integer(),
sibpos = NA_integer_,
nsibs = NA_integer_,
max_width = NULL
)
## S4 method for signature 'TableRow'
make_row_df(
tt,
colwidths = NULL,
visible_only = TRUE,
rownum = 0,
indent = 0L,
path = "root",
incontent = FALSE,
repr_ext = 0L,
repr_inds = integer(),
sibpos = NA_integer_,
nsibs = NA_integer_,
max_width = NULL
)
## S4 method for signature 'LabelRow'
make_row_df(
tt,
colwidths = NULL,
visible_only = TRUE,
rownum = 0,
indent = 0L,
path = "root",
incontent = FALSE,
repr_ext = 0L,
repr_inds = integer(),
sibpos = NA_integer_,
nsibs = NA_integer_,
max_width = NULL
)
obj |
ANY. The object for the accessor to access or modify |
value |
The new value |
x |
An object |
colwidths |
numeric vector. Column widths for use with vertical pagination. |
max_width |
numeric(1). Width strings should be wrapped to when determining how many lines they require. |
tt |
|
visible_only |
logical(1). Should only visible aspects of the table structure be reflected in this summary.
Defaults to |
rownum |
numeric(1). Internal detail do not set manually. |
indent |
integer(1). Internal detail do not set manually. |
path |
character. A vector path for a position within the structure of a
|
incontent |
logical(1). Internal detail do not set manually. |
repr_ext |
integer(1). Internal detail do not set manually. |
repr_inds |
integer. Internal detail do not set manually. |
sibpos |
integer(1). Internal detail do not set manually. |
nsibs |
integer(1). Internal detail do not set manually. |
When visible_only
is TRUE
(the default),
methods should return a data.frame with exactly one row per
visible row in the table-like object. This is useful when
reasoning about how a table will print, but does not reflect
the full pathing space of the structure (though the paths which
are given will all work as is).
If supported, when visible_only
is FALSE
, every
structural element of the table (in row-space) will be reflected in
the returned data.frame, meaning the full pathing-space will be
represented but some rows in the layout summary will not represent
printed rows in the table as it is displayed.
Most arguments beyond tt
and visible_only
are present so that
make_row_df
methods can call make_row_df
recursively and retain information,
and should not be set during a top-level call
for getters, the current value of the component being accessed
on obj
, for setters, a modified copy of obj
with the new value.
the technically present root tree node is excluded from the summary returned by
both make_row_df
and make_col_df
, as it is simply the
row/column structure of tt
and thus not useful for pathing or pagination.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.