General Argument Conventions
gen_args(
df,
alt_counts_df,
spl,
pos,
tt,
tr,
verbose,
colwidths,
obj,
x,
value,
object,
path,
label,
label_pos,
cvar,
topleft,
...
)dataset (data.frame or tibble)
dataset (data.frame or tibble). Alternative full data the rtables framework will use (only) when calculating column counts.
A Split object defining a partitioning or analysis/tabulation of the data.
numeric. Which top-level set of nested splits should the new layout feature be added to. Defaults to the current
TableTree (or related class). A TableTree object representing a populated table.
TableRow (or related class). A TableRow object representing a single row within a populated table.
logical(1). Should extra debugging messages be shown. Defaults to FALSE.
numeric vector. Column widths for use with vertical pagination. Currently ignored.
ANY. The object for the accessor to access or modify
An object
The new value
The object to modify in-place
character. A vector path for a position within the structure of a tabletree. Each element represents a subsequent choice amongst the children of the previous choice.
character(1). A label (not to be confused with the name) for the object/structure.
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.
character(1). The variable, if any, which the content function should accept. Defaults to NA.
character. Override values for the "top left" material to be displayed during printing.
Passed on to metthods or tabulation functions.
NULL (this is an argument template dummy function)
Other conventions:
compat_args(),
constr_args(),
lyt_args(),
sf_args()