plot-doc

Helper for consistent documentation for plots.

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à

plot-doc function

<dl><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>visOmopResults::plotStyle()</code>), or a path to a .yml file that defines a
custom style. If <code>NULL</code>, the function will use the explicit default style,
unless a global style option is set (see <code>visOmopResults::setGlobalPlotOptions()</code>)
or a _brand.yml file is present (in that order).</dd>
<dt>type</dt>
<dd>Character string indicating the output plot format. See
<code>visOmopResults::plotType()</code> for the list of supported plot types. If
<code>type = NULL</code>, the function will use the global setting defined via
<code>visOmopResults::setGlobalPlotOptions()</code> (if available); otherwise, a
standard <code>ggplot2</code> plot is produced by default.</dd></dl>

Arguments

Helper for consistent documentation for plots. — plot-doc

<dl>

<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>visOmopResults::plotStyle()</code>), or a path to a .yml file that defines a
custom style. If <code>NULL</code>, the function will use the explicit default style,
unless a global style option is set (see <code>visOmopResults::setGlobalPlotOptions()</code>)
or a _brand.yml file is present (in that order).</dd>


<dt>type</dt>
<dd>Character string indicating the output plot format. See
<code>visOmopResults::plotType()</code> for the list of supported plot types. If
<code>type = NULL</code>, the function will use the global setting defined via
<code>visOmopResults::setGlobalPlotOptions()</code> (if available); otherwise, a
standard <code>ggplot2</code> plot is produced by default.</dd>

</dl>

plot-doc: Helper for consistent documentation for plots.

Description

Arguments