tableDoc

Helper for consistent documentation of `table`.

internal

Diagnostics of list of codes based on concepts from the domains measurement and observation. This package works for data mapped to the Observational Medical Outcomes Partnership Common Data Model.

Nuria Mercade-Besora

MeasurementDiagnostics

Diagnostics for Lists of Codes Based on Measurements

Edward Burn

Marta Alcalde-Herraiz

tableDoc function

<dl><dt>type</dt>
<dd>Type of table. Check supported types with
`visOmopResults::tableType()`.</dd>
<dt>header</dt>
<dd>Columns to use as header. See options with
`visOmopResults::tableColumns(result)`.</dd>
<dt>groupColumn</dt>
<dd>Columns to group by. See options with
`visOmopResults::tableColumns(result)`.</dd>
<dt>settingsColumn</dt>
<dd>Columns from settings to include in results. See
options with `visOmopResults::settingsColumns(result)`.</dd>
<dt>hide</dt>
<dd>Columns to hide from the visualisation. See options with
`visOmopResults::tableColumns(result)`.</dd>
<dt>style</dt>
<dd>Named list that specifies how to style the different parts of
the table generated. It can either be a pre-defined style ("default" or
"darwin" - the latter just for gt and flextable), NULL to get the table type
default style, or custom. Keep in mind that styling code is different for
all table styles. To see the different styles use visOmopResults::tableStyle().</dd>
<dt>.options</dt>
<dd>A named list with additional formatting options.
`visOmopResults::tableOptions()` shows allowed arguments and their default values.</dd></dl>

Arguments

Helper for consistent documentation of `table`. — tableDoc

<dl>

<dt>type</dt>
<dd>Type of table. Check supported types with
`visOmopResults::tableType()`.</dd>


<dt>header</dt>
<dd>Columns to use as header. See options with
`visOmopResults::tableColumns(result)`.</dd>


<dt>groupColumn</dt>
<dd>Columns to group by. See options with
`visOmopResults::tableColumns(result)`.</dd>


<dt>settingsColumn</dt>
<dd>Columns from settings to include in results. See
options with `visOmopResults::settingsColumns(result)`.</dd>


<dt>hide</dt>
<dd>Columns to hide from the visualisation. See options with
`visOmopResults::tableColumns(result)`.</dd>


<dt>style</dt>
<dd>Named list that specifies how to style the different parts of
the table generated. It can either be a pre-defined style ("default" or
"darwin" - the latter just for gt and flextable), NULL to get the table type
default style, or custom. Keep in mind that styling code is different for
all table styles. To see the different styles use visOmopResults::tableStyle().</dd>


<dt>.options</dt>
<dd>A named list with additional formatting options.
`visOmopResults::tableOptions()` shows allowed arguments and their default values.</dd>

</dl>

tableDoc: Helper for consistent documentation of `table`.

Description

Arguments