CellValue

ANY. value in the cell exactly as it should be passed to a formatter or returned when extracted

FormatSpec. Format associated with this split. Formats can be declared via strings (<code>"xx.x"</code>) or function. In cases such as <code>analyze</code> calls, they can character vectors or lists of functions.

format

colspan

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

label

numeric. Modifier for the default indent position for the structure created by this function(subtable, content table, or row) and all of that structure's children. Defaults to 0, which corresponds to the unmodified default behavior.

indent_mod

list or NULL. Referential footnote messages for the cell.

footnotes

character(1). Alignment the value should be rendered with. See <code><a rd-options="" href="/link/rtables_aligns?package=rtables&version=0.5.1" data-mini-rdoc="rtables::rtables_aligns">rtables_aligns</a></code> for currently supported alignments.

align

character(1). String which should be displayed when formatted if this cell's value(s) are all NA.

format_na_str

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

Adrian Waddell

Daniel Sabanés Bové

Maximilian Mordig

CellValue function

<dl><dt>val</dt>
<dd>ANY. value in the cell exactly as it should be passed to a formatter or returned when extracted</dd>
<dt>format</dt>
<dd>FormatSpec. Format associated with this split. Formats can be declared via strings (<code>"xx.x"</code>) or function. In cases such as <code>analyze</code> calls, they can character vectors or lists of functions.</dd>
<dt>colspan</dt>
<dd>integer(1). Columnspan value.</dd>
<dt>label</dt>
<dd>character(1). A label (not to be confused with the name) for the object/structure.</dd>
<dt>indent_mod</dt>
<dd>numeric. Modifier for the default indent position for the structure created by this function(subtable, content table, or row) and all of that structure's children. Defaults to 0, which corresponds to the unmodified default behavior.</dd>
<dt>footnotes</dt>
<dd>list or NULL. Referential footnote messages for the cell.</dd>
<dt>align</dt>
<dd>character(1). Alignment the value should be rendered with. See <code>rtables_aligns</code> for currently supported alignments.</dd>
<dt>format_na_str</dt>
<dd>character(1). String which should be displayed when formatted if this cell's value(s) are all NA.</dd></dl>

Arguments

Cell Value constructor — CellValue

<dl>

<dt>val</dt>
<dd>ANY. value in the cell exactly as it should be passed to a formatter or returned when extracted</dd>


<dt>format</dt>
<dd>FormatSpec. Format associated with this split. Formats can be declared via strings (<code>"xx.x"</code>) or function. In cases such as <code>analyze</code> calls, they can character vectors or lists of functions.</dd>


<dt>colspan</dt>
<dd>integer(1). Columnspan value.</dd>


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


<dt>indent_mod</dt>
<dd>numeric. Modifier for the default indent position for the structure created by this function(subtable, content table, or row) and all of that structure's children. Defaults to 0, which corresponds to the unmodified default behavior.</dd>


<dt>footnotes</dt>
<dd>list or NULL. Referential footnote messages for the cell.</dd>


<dt>align</dt>
<dd>character(1). Alignment the value should be rendered with. See <code>rtables_aligns</code> for currently supported alignments.</dd>


<dt>format_na_str</dt>
<dd>character(1). String which should be displayed when formatted if this cell's value(s) are all NA.</dd>

</dl>

CellValue: Cell Value constructor

Description

Usage

Value

Arguments