plotCohortTiming {CohortCharacteristics}R Documentation

Plot summariseCohortTiming results.

Description

'r lifecycle::badge("experimental")'

Usage

plotCohortTiming(
  result,
  plotType = "boxplot",
  timeScale = "days",
  facet = NULL,
  colour = NULL,
  colourName = NULL,
  uniqueCombinations = TRUE,
  .options = list()
)

Arguments

result

A summariseCohortTiming result.

plotType

Type of desired formatted table, possibilities are "boxplot" and "density".

timeScale

Time scale to plot results. Can be days or years.

facet

variables to facet by

colour

Variables to use for colours

colourName

Colour legend name

uniqueCombinations

If TRUE, only unique combinations of reference and comparator plots will be plotted.

.options

Additional plotting options

Value

A ggplot.

Examples


library(CohortCharacteristics)
cdm <- CohortCharacteristics::mockCohortCharacteristics()
timing <- summariseCohortTiming(cdm$cohort2)
plotCohortTiming(timing)
CDMConnector::cdmDisconnect(cdm = cdm)



[Package CohortCharacteristics version 0.2.0 Index]