compat_args: Compatibility argument conventions

In rtables: Reporting Tables

Compatibility argument conventions

Description

Compatibility argument conventions

Usage

compat_args(.lst, row.name, format, indent, label, inset)

Arguments

.lst	(list) an already-collected list of arguments to be used instead of the elements of .... Arguments passed via ... will be ignored if this is specified.
row.name	(string or NULL) row name. If NULL, an empty string is used as row.name of the rrow().
format	(string, function, or list) the format label (string) or formatter function to apply to the cell values passed via .... See formatters::list_valid_format_labels() for currently supported format labels.
indent
label	(string) a label (not to be confused with the name) for the object/structure.
inset	(integer(1)) the table inset for the row or table being constructed. See formatters::table_inset() for details.

Value

No return value.

See Also

Other conventions: constr_args(), gen_args(), lyt_args(), sf_args()

rtables documentation built on Sept. 30, 2024, 9:32 a.m.