Plot the result of summariseCohortOverlap. — plotCohortOverlap • CohortCharacteristics

Usage

plotCohortOverlap(
  result,
  uniqueCombinations = TRUE,
  facet = c("cdm_name", "cohort_name_reference"),
  colour = "variable_name",
  style = NULL,
  .options = lifecycle::deprecated()
)

Arguments

result: A summarised_result object.
uniqueCombinations: Whether to restrict to unique reference and comparator comparisons.
facet: Columns to facet by. See options with availablePlotColumns(result). Formula is also allowed to specify rows and columns.
colour: Columns to color by. See options with availablePlotColumns(result).
style: Visual theme to apply. Character, or NULL. If a character, this may be either the name of a built-in style (see 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 setGlobalPlotOptions()), or a ⁠_brand.yml⁠ file is present (in that order). Refer to the package vignette on styles to learn more.
.options: deprecated.

Value

A ggplot.

Examples

# \donttest{
library(CohortCharacteristics)

cdm <- mockCohortCharacteristics()
#> Warning: There are observation period end dates after the current date: 2025-12-09
#> ℹ The latest max observation period end date found is 2031-09-13

overlap <- summariseCohortOverlap(cdm$cohort2)

plotCohortOverlap(overlap, uniqueCombinations = FALSE)


# }