create a ggplot from the output of summariseLargeScaleCharacteristics.

Usage

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

Arguments

result

A summarised_result object. Output of summariseCohortAttrition().

show

Which variables to show in the attritoin plot, it can be 'subjects', 'records' or both.

cohortId

deprecated.

Value

A grViz visualisation.

Examples

# \donttest{
library(CohortCharacteristics)
library(omopgenerics)
#> 
#> Attaching package: ‘omopgenerics’
#> The following objects are masked from ‘package:CDMConnector’:
#> 
#>     cdmName, recordCohortAttrition, uniqueTableName
#> The following object is masked from ‘package:stats’:
#> 
#>     filter
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)
# }