plotDoc

Helper for consistent documentation of <code>plot</code>.

internal

Summarise and visualise the characteristics of patients in data
mapped to the Observational Medical Outcomes Partnership (OMOP) common data
model (CDM).

Marti Catala

CohortCharacteristics

Summarise and Visualise Characteristics of Patients in the OMOP
CDM

Martí Català

Yuchen Guo

Mike Du

Kim Lopez-Guell

Edward Burn

Nuria Mercade-Besora

Marta Alcalde

plotDoc function

<dl><dt>facet</dt>
<dd>Columns to facet by. See options with
<code>availablePlotColumns(result)</code>. Formula is also allowed to specify rows and
columns.</dd>
<dt>colour</dt>
<dd>Columns to color by. See options with
<code>availablePlotColumns(result)</code>.</dd>
<dt>style</dt>
<dd>Visual theme to apply. Character, or <code>NULL</code>. If a character, this
may be either the name of a built-in style (see <code>plotStyle()</code>), or a path to
a <code>.yml</code> file that defines a custom style. If NULL, the function will use the
explicit default style, unless a global style option is set (see
<code>setGlobalPlotOptions()</code>), or a _brand.yml file is present (in that order).
Refer to the package vignette on styles to learn more.</dd></dl>

Arguments

Helper for consistent documentation of plot. — plotDoc

<dl>

<dt>facet</dt>
<dd>Columns to facet by. See options with
<code>availablePlotColumns(result)</code>. Formula is also allowed to specify rows and
columns.</dd>


<dt>colour</dt>
<dd>Columns to color by. See options with
<code>availablePlotColumns(result)</code>.</dd>


<dt>style</dt>
<dd>Visual theme to apply. Character, or <code>NULL</code>. If a character, this
may be either the name of a built-in style (see <code>plotStyle()</code>), or a path to
a <code>.yml</code> file that defines a custom style. If NULL, the function will use the
explicit default style, unless a global style option is set (see
<code>setGlobalPlotOptions()</code>), or a _brand.yml file is present (in that order).
Refer to the package vignette on styles to learn more.</dd>

</dl>

Helper for consistent documentation of <code>plot</code>.

plotDoc: Helper for consistent documentation of `plot`.

Description

Arguments