compat_args: Compatibility Arg Conventions

View source: R/argument_conventions.R

compat_argsR Documentation

Compatibility Arg Conventions

Description

Compatibility Arg 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

if NULL then an empty string is used as row.name of the rrow.

format

character(1) or function. The format label (string) or formatter function to apply to the cell values passed via .... See list_valid_format_labels for currently supported format labels.

indent

deprecated.

label

character(1). 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 table_inset.

Value

NULL (this is an argument template dummy function)

See Also

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


rtables documentation built on Aug. 30, 2023, 5:07 p.m.