Constructor Arg Conventions
constr_args(
kids,
cont,
lev,
iscontent,
cinfo,
labelrow,
vals,
cspan,
label_pos,
cindent_mod,
cvar,
label,
cextra_args,
child_names,
title,
subtitles,
main_footer,
prov_footer,
footnotes,
page_title,
page_prefix,
section_div,
trailing_section_div,
split_na_str,
cna_str,
inset,
table_inset,
header_section_div
)NULL (this is an argument template dummy function)
list. List of direct children.
ElementaryTable. Content table.
integer. Nesting level (roughly, indentation level in practical terms).
logical. Is the TableTree/ElementaryTable being constructed
the content table for another TableTree.
InstantiatedColumnInfo (or NULL). Column structure for the
object being created.
LabelRow. The LabelRow object to assign to this Table.
Constructed from label by default if not specified.
list. cell values for the row
integer. Column span. 1 indicates no spanning.
character(1). Location the variable label should be
displayed, Accepts "hidden" (default for non-analyze row splits), "visible",
"topleft", and - for analyze splits only - "default". For analyze calls,
"default" indicates that the variable should be visible if and only if
multiple variables are analyzed at the same level of nesting.
numeric(1). The indent modifier for the content tables generated by this split.
character(1). The variable, if any, which the content function should accept. Defaults to NA.
character(1). A label (not to be confused with the name) for the object/structure.
list. Extra arguments to be passed to the content function when tabulating row group summaries.
character. Names to be given to the sub splits contained
by a compound split (typically a AnalyzeMultiVars split object).
character(1). Main title (main_title()) is a single string.
Ignored for subtables.
character. Subtitles (subtitles()) can be vector of strings, where
every element is printed in a separate line. Ignored for subtables.
character. Main global (non-referential) footer materials
(main_footer()). If it is a vector of strings, they will be printed on separate
lines.
character. Provenance-related global footer materials
(prov_footer()). It can be also a vector of strings, printed on different lines.
Generally should not be modified by hand.
list or NULL. Referential footnotes to be applied at current
level. In post-processing, this can be achieved with fnotes_at_path<-.
character. Page specific title(s).
character(1). Prefix, to be appended with the split value, when forcing pagination between the children of this split/table
character(1). String which should be repeated as a section
divider after each group defined by this split instruction, or
NA_character_ (the default) for no section divider.
character(1). String which will be used as a section
divider after the printing of the last row contained in this (sub)-table,
unless that row is also the last table row to be printed overall, or
NA_character_ for none (the default). When generated via layouting, this
would correspond to the section_div of the split under which this table
represents a single facet.
character. NA string vector for use with split_format.
character. NA string for use with cformat for content
table.
numeric(1). Number of spaces to inset the table header, table body, referential footnotes, and main_footer, as compared to alignment of title, subtitle, and provenance footer. Defaults to 0 (no inset).
numeric(1). Number of spaces to inset the table header, table body, referential footnotes, and main_footer, as compared to alignment of title, subtitle, and provenance footer. Defaults to 0 (no inset).
character(1). String which will be used to divide the header
from the table. See header_section_div() for getter and setter of these.
Please consider changing last element of section_div() when concatenating
tables that need a divider between them.
Other conventions:
compat_args(),
gen_args(),
lyt_args(),
sf_args()