plotDoc

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

internal

Summarise patient-level drug utilisation cohorts using data mapped
to the Observational Medical Outcomes Partnership (OMOP) common data model.
New users and prevalent users cohorts can be generated and their
characteristics, indication and drug use summarised.

Marti Catala

DrugUtilisation

Summarise Patient-Level Drug Utilisation in Data Mapped to the
OMOP Common Data Model

Martí Català

Mike Du

Yuchen Guo

Kim Lopez-Guell

Edward Burn

Xintong Li

Marta Alcalde-Herraiz

Nuria Mercade-Besora

Xihang Chen

plotDoc function

<dl><dt>x</dt>
<dd>Variable to plot on x-axis</dd>
<dt>position</dt>
<dd>Position of bars, can be either <code>dodge</code> or <code>stack</code></dd>
<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>visOmopResults::setGlobalPlotOptions()</code>) or a <code>_brand.yml</code> file is present
(in that order). Refer to the visOmopResults package vignette on styles
to learn more.</dd></dl>

Arguments

Helper for consistent documentation of plot. — plotDoc

<dl>

<dt>x</dt>
<dd>Variable to plot on x-axis</dd>


<dt>position</dt>
<dd>Position of bars, can be either <code>dodge</code> or <code>stack</code></dd>


<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>visOmopResults::setGlobalPlotOptions()</code>) or a <code>_brand.yml</code> file is present
(in that order). Refer to the visOmopResults 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