sf_args

Split function 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

sf_args function

<dl><dt>trim</dt>
<dd>(<code>flag</code>) whether splits corresponding with 0 observations should be kept when tabulating.</dd>
<dt>label</dt>
<dd>(<code>string</code>) a label (not to be confused with the name) for the object/structure.</dd>
<dt>first</dt>
<dd>(<code>flag</code>) whether the created split level should be placed first in the levels (<code>TRUE</code>) or
last (<code>FALSE</code>, the default).</dd></dl>

Arguments

Split function argument conventions — sf_args

<dl>

<dt>trim</dt>
<dd>(<code>flag</code>) whether splits corresponding with 0 observations should be kept when tabulating.</dd>


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


<dt>first</dt>
<dd>(<code>flag</code>) whether the created split level should be placed first in the levels (<code>TRUE</code>) or
last (<code>FALSE</code>, the default).</dd>

</dl>

sf_args: Split function argument conventions

Description

Usage

Value

Arguments

See Also