style-table

Helper for consistent documentation of table arguments.

internal

Summarises key information in data mapped to the Observational
Medical Outcomes Partnership (OMOP) common data model. Assess suitability to
perform specific epidemiological studies and explore the different domains
to obtain feasibility counts and trends.

Cecilia Campanile

OmopSketch

Characterise Tables of an OMOP Common Data Model Instance

Marta Alcalde-Herraiz

Kim Lopez-Guell

Elin Rowlands

Edward Burn

Martí Català

style-table function

<dl><dt>type</dt>
<dd>Character string specifying the desired output table format. See
<code>visOmopResults::tableType()</code> for supported table types. If <code>type = NULL</code>,
global options (set via <code>visOmopResults::setGlobalTableOptions()</code>) will be
used if available; otherwise, a default 'gt' table is created.</dd>
<dt>style</dt>
<dd>Defines the visual formatting of the table. This argument can be
provided in one of the following ways:<ol>
<li>Pre-defined style: Use the name of a built-in style (e.g., "darwin").
See <code>visOmopResults::tableStyle()</code> for available options.</li>
<li>YAML file path: Provide the path to an existing .yml file defining
a new style.</li>
<li>List of custome R code: Supply a block of custom R code or a named
list describing styles for each table section. This code must be specific to
the selected table type.</li>
</ol></dd>If <code>style = NULL</code>, the function will use global options
(see<code>visOmopResults::setGlobalTableOptions()</code>) or a _brand.yml file
(if found); otherwise, the default style is applied.
<dt>header</dt>
<dd>A vector specifying the elements to include in the header.
The order of elements matters, with the first being the topmost header.</dd>
<dt>hide</dt>
<dd>Columns to drop from the output table.</dd>
<dt>groupColumn</dt>
<dd>Columns to use as group labels, to see options use
visOmopResults::tableColumns(result).</dd></dl>

Arguments

Helper for consistent documentation of table arguments. — style-table

<dl>

<dt>type</dt>
<dd>Character string specifying the desired output table format. See
<code>visOmopResults::tableType()</code> for supported table types. If <code>type = NULL</code>,
global options (set via <code>visOmopResults::setGlobalTableOptions()</code>) will be
used if available; otherwise, a default 'gt' table is created.</dd>


<dt>style</dt>
<dd>Defines the visual formatting of the table. This argument can be
provided in one of the following ways:<ol>
<li>Pre-defined style: Use the name of a built-in style (e.g., "darwin").
See <code>visOmopResults::tableStyle()</code> for available options.</li>
<li>YAML file path: Provide the path to an existing .yml file defining
a new style.</li>
<li>List of custome R code: Supply a block of custom R code or a named
list describing styles for each table section. This code must be specific to
the selected table type.</li>
</ol>

If <code>style = NULL</code>, the function will use global options
(see<code>visOmopResults::setGlobalTableOptions()</code>) or a _brand.yml file
(if found); otherwise, the default style is applied.</dd>


<dt>header</dt>
<dd>A vector specifying the elements to include in the header.
The order of elements matters, with the first being the topmost header.</dd>


<dt>hide</dt>
<dd>Columns to drop from the output table.</dd>


<dt>groupColumn</dt>
<dd>Columns to use as group labels, to see options use
visOmopResults::tableColumns(result).</dd>

</dl>

style-table: Helper for consistent documentation of table arguments.

Description

Arguments