Layouting Function Arg Conventions
lyt_args(
lyt,
var,
vars,
label,
labels_var,
varlabels,
varnames,
split_format,
nested,
format,
cfun,
cformat,
split_fun,
split_name,
split_label,
afun,
inclNAs,
valorder,
ref_group,
compfun,
label_fstr,
child_labels,
extra_args,
name,
cuts,
cutlabels,
cutfun,
cutlabelfun,
cumulative,
indent_mod,
show_labels,
label_pos,
var_labels,
cvar,
table_names,
topleft
)layout object pre-data used for tabulation
string, variable name
character vector. Multiple variable names.
character(1). A label (not to be confused with the name) for the object/structure.
string, name of variable containing labels to be displayed for the values of var
character vector. Labels for vars
character vector. Names for vars which will appear in pathing. When vars are all unique this will be the variable names. If not, these will be variable names with suffixes as necessary to enforce uniqueness.
FormatSpec. Default format associated with the split being created.
boolean, Add this as a new top-level split (defining a new subtable directly under root). Defaults to FALSE
FormatSpec. Format associated with this split. Formats can be declared via strings ("xx.x") or function. In cases such as analyze calls, they can character vectors or lists of functions.
list/function/NULL. tabulation function(s) for creating content rows. Must accept x or df as first parameter. Must accept labelstr as the second argument. Can optionally accept all optional arguments accepted by analysis functions. See analyze.
format spec. Format for content rows
function/NULL. custom splitting function See custom_split_funs
string. Name associiated with this split (for pathing, etc)
string. Label string to be associated with the table generated by the split. Not to be confused with labels assigned to each child (which are based on the data and type of split during tabulation).
function. Analysis function, must take x or df as its first parameter. Can optionally take other parameters which will be populated by the tabulation framework. See Details in analyze.
boolean. Should observations with NA in the var variable(s) be included when performing this analysis. Defaults to FALSE
character vector. Order that the split children should appear in resulting table.
character. Value of var to be taken as the ref_group/control to be compared against.
function/string. The comparison function which accepts the analysis function outputs for two different partitions and returns a single value. Defaults to subraction. If a string, taken as the name of a function.
string. An sprintf style format string containing. For non-comparison splits, it can contain up to one "%s" which takes the current split value and generates the row/column label. Comparison-based splits it can contain up to two "%s".
string. One of "default", "visible", "hidden". What should the display behavior be for the labels (ie label rows) of the children of this split. Defaults to "default" which flags the label row as visible only if the child has 0 content rows.
list. Extra arguments to be passed to the tabulation function. Element position in thte list corresponds to the children of this split. Named elements in the child-specific lists are ignored if they do not match a formal argument of the ttabulation function.
character(1). Name of the split/table/row being creatted. Defaults to same as the corresponding llabel, but is not required to be.
numeric. Cuts to use
character (or NULL). Labels for the cuts
function. Function which accepts the full vector of var values and returns cut points to be used (via cut) when splitting data during tabulation
function. Function which returns either labels for the cuts or NULL when passed the return value of cutfun
logical. Should the cuts be treated as cumulative. Defaults to FALSE
numeric. Modifier for the default indent position for the structure created by this function(subtable, content table, or row) and all of that structure's children. Defaults to 0, which corresponds to the unmodified default behavior.
character(1). Should the variable labels for corresponding to the variable(s) in vars be visible in the resulting table.
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. Variable labels for 1 or more variables
character(1). The variable, if any, which the content function should accept. Defaults to NA.
character. Names for the tables representing each atomic analysis. Defaults to var.
character. Override values for the "top left" material to be displayed during printing.
NULL (this is an argument template dummy function)
Other conventions:
compat_args(),
constr_args(),
gen_args(),
sf_args()