plotPrevalence: Plot prevalence results

In IncidencePrevalence: Estimate Incidence and Prevalence using the OMOP Common Data Model

Plot prevalence results

Description

Plot prevalence results

Usage

plotPrevalence(
  result,
  x = "prevalence_start_date",
  y = "prevalence",
  line = FALSE,
  point = TRUE,
  ribbon = FALSE,
  ymin = "prevalence_95CI_lower",
  ymax = "prevalence_95CI_upper",
  facet = NULL,
  colour = NULL
)

Arguments

result	Prevalence results
x	Variable to plot on x axis
y	Variable to plot on y axis.
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
facet	Variables to use for facets. To see available variables for facetting use the function availablePrevalenceGrouping().
colour	Variables to use for colours. To see available variables for colouring use the function availablePrevalenceGrouping().

Value

A ggplot with the prevalence results plotted

Examples

cdm <- mockIncidencePrevalence(sampleSize = 1000)
cdm <- generateDenominatorCohortSet(
  cdm = cdm, name = "denominator",
  cohortDateRange = c(as.Date("2014-01-01"), as.Date("2018-01-01"))
)
prev <- estimatePointPrevalence(
  cdm = cdm,
  denominatorTable = "denominator",
  outcomeTable = "outcome"
)
plotPrevalence(prev)

IncidencePrevalence documentation built on Aug. 8, 2025, 6:38 p.m.