plot-doc: Helper for consistent documentation for plots.

In OmopSketch: Characterise Tables of an OMOP Common Data Model Instance

Helper for consistent documentation for plots.

Description

Helper for consistent documentation for plots.

Arguments

style	Visual theme to apply. Character, or NULL. If a character, this may be either the name of a built-in style (see visOmopResults::plotStyle()), or a path to a .yml file that defines a custom style. If NULL, the function will use the explicit default style, unless a global style option is set (see visOmopResults::setGlobalPlotOptions()) or a _brand.yml file is present (in that order).
type	Character string indicating the output plot format. See visOmopResults::plotType() for the list of supported plot types. If type = NULL, the function will use the global setting defined via visOmopResults::setGlobalPlotOptions() (if available); otherwise, a standard ggplot2 plot is produced by default.

OmopSketch documentation built on Aug. 27, 2026, 5:07 p.m.