plotCohortAttrition: create a ggplot from the output of...

In CohortCharacteristics: Summarise and Visualise Characteristics of Patients in the OMOP CDM

create a ggplot from the output of summariseLargeScaleCharacteristics.

Description

Usage

plotCohortAttrition(
  result,
  show = c("subjects", "records"),
  type = "htmlwidget",
  cohortId = lifecycle::deprecated()
)

Arguments

result	A summarised_result object.
show	Which variables to show in the attrition plot, it can be 'subjects', 'records' or both.
type	type of the output, it can either be: 'htmlwidget', 'png', or 'DiagrammeR'.
cohortId	deprecated.

Value

A grViz visualisation.

Examples

library(CohortCharacteristics)
library(omopgenerics)
library(dplyr, warn.conflicts = FALSE)

cdm <- mockCohortCharacteristics(numberIndividuals = 1000)

cdm[["cohort1"]] <- cdm[["cohort1"]] |>
  filter(year(cohort_start_date) >= 2000) |>
  recordCohortAttrition("Restrict to cohort_start_date >= 2000") |>
  filter(year(cohort_end_date) < 2020) |>
  recordCohortAttrition("Restrict to cohort_end_date < 2020") |>
  compute(temporary = FALSE, name = "cohort1")

result <- summariseCohortAttrition(cdm$cohort1)

result |>
  filter(group_level == "cohort_2") |>
  plotCohortAttrition()

mockDisconnect(cdm)

CohortCharacteristics documentation built on April 3, 2025, 10:29 p.m.