compat_args

Reporting tables often have structure that goes beyond simple rectangular
data. The 'rtables' package provides a framework for declaring complex multi-level tabulations
and then applying them to data. This framework models both tabulation and the resulting
tables as hierarchical, tree-like objects which support sibling sub-tables, arbitrary splitting
or grouping of data in row and column dimensions, cells containing multiple values,
and the concept of contextual summary computations. A convenient pipe-able interface is provided
for declaring table layouts and the corresponding computations, and then applying them to data.

Gabriel Becker

rtables

Reporting Tables

compat_args function

<dl><dt>.lst</dt>
<dd>list. An already-collected list of arguments to be used instead
of the elements of <code>...</code>. Arguments passed via <code>...</code> will be
ignored if this is specified.</dd>
<dt>row.name</dt>
<dd>if <code>NULL</code> then an empty string is used as
<code>row.name</code> of the <code>rrow</code>.</dd>
<dt>format</dt>
<dd>character(1) or function. The format label (string) or
formatter function to apply to the cell values passed via <code>...</code>. See
<code>list_valid_format_labels</code> for currently supported
format labels.</dd>
<dt>indent</dt>
<dd>deprecated.</dd>
<dt>label</dt>
<dd>character(1). A label (not to be confused with the name) for the
object/structure.</dd>
<dt>inset</dt>
<dd>integer(1). The table inset for the row or table being
constructed. See <code>table_inset</code>.</dd></dl>

Arguments

Compatibility Arg Conventions — compat_args

<dl>

<dt>.lst</dt>
<dd>list. An already-collected list of arguments to be used instead
of the elements of <code>...</code>. Arguments passed via <code>...</code> will be
ignored if this is specified.</dd>


<dt>row.name</dt>
<dd>if <code>NULL</code> then an empty string is used as
<code>row.name</code> of the <code>rrow</code>.</dd>


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


<dt>indent</dt>
<dd>deprecated.</dd>


<dt>label</dt>
<dd>character(1). A label (not to be confused with the name) for the
object/structure.</dd>


<dt>inset</dt>
<dd>integer(1). The table inset for the row or table being
constructed. See <code>table_inset</code>.</dd>

</dl>

compat_args: Compatibility Arg Conventions

Description

Usage

Value

Arguments

See Also