plotDoc: Helper for consistent documentation of 'plots'.

In visOmopResults: Graphs and Tables for OMOP Results

Helper for consistent documentation of plots.

Description

Helper for consistent documentation of plots.

Arguments

result	A ⁠<summarised_result>⁠ object.
x	Column or estimate name that is used as x variable.
y	Column or estimate name that is used as y variable.
width	Bar width, as in geom_col() of the ggplot2 package.
just	Adjustment for column placement, as in geom_col() of the ggplot2 package.
facet	Variables to facet by, a formula can be provided to specify which variables should be used as rows and which ones as columns.
colour	Columns to use to determine the colours.
group	Columns to use to determine the group.
label	Character vector with the columns to display interactively in plotly.
style	Which style to apply to the plot, options are: "default", "darwin" and NULL (default ggplot style). Customised styles can be achieved by modifying the returned ggplot object.
lower	Estimate name for the lower quantile of the box.
middle	Estimate name for the middle line of the box.
upper	Estimate name for the upper quantile of the box.
line	Whether to plot a line using geom_line.
point	Whether to plot points using geom_point.
ribbon	Whether to plot a ribbon using geom_ribbon.
ymin	Lower limit of error bars, if provided is plot using geom_errorbar.
ymax	Upper limit of error bars, if provided is plot using geom_errorbar.

visOmopResults documentation built on Sept. 9, 2025, 5:42 p.m.