compat_args

Compatibility argument conventions

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.

Joe Zhu

rtables

Reporting Tables

compat_args function

<dl><dt>.lst</dt>
<dd>(<code>list</code>) 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>(<code>string</code> or <code>NULL</code>) row name. If <code>NULL</code>, an empty string is used as <code>row.name</code> of the
<code>rrow()</code>.</dd>
<dt>format</dt>
<dd>(<code>string</code>, <code>function</code>, or <code>list</code>) the format label (string) or formatter function to apply to the
cell values passed via <code>...</code>. See <code>formatters::list_valid_format_labels()</code> for currently supported format labels.</dd>
<dt>indent</dt>
<dd><a href="https://lifecycle.r-lib.org/articles/stages.html#deprecated"><img src="figures/lifecycle-deprecated.svg?package=rtables&version=0.6.12" alt="[Deprecated]"></a></dd>
<dt>label</dt>
<dd>(<code>string</code>) a label (not to be confused with the name) for the object/structure.</dd>
<dt>inset</dt>
<dd>(<code>integer(1)</code>) the table inset for the row or table being constructed. See
<code>formatters::table_inset()</code> for details.</dd></dl>

Arguments

Compatibility argument conventions — compat_args

<dl>

<dt>.lst</dt>
<dd>(<code>list</code>) 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>(<code>string</code> or <code>NULL</code>) row name. If <code>NULL</code>, an empty string is used as <code>row.name</code> of the
<code>rrow()</code>.</dd>


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


<dt>indent</dt>
<dd><a href='https://lifecycle.r-lib.org/articles/stages.html#deprecated'><img src='figures/lifecycle-deprecated.svg' alt='[Deprecated]' /></a></dd>


<dt>label</dt>
<dd>(<code>string</code>) a label (not to be confused with the name) for the object/structure.</dd>


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

</dl>

compat_args: Compatibility argument conventions

Description

Usage

Value

Arguments

See Also