tableCohortAttrition {CohortCharacteristics}

Create a visual table from the output of summariseCohortAttrition. 'r lifecycle::badge("experimental")'

Description

Create a visual table from the output of summariseCohortAttrition. 'r lifecycle::badge("experimental")'

Usage

tableCohortAttrition(
  result,
  header = "cdm_name",
  groupColumn = "cohort_name",
  type = "gt"
)

Arguments

result

A summarised_result object generated by summariseCohortAttrition().

header

Columns to use as headers.

groupColumn

Columns to use to group.

type

Whether a 'gt', 'flextable' or a 'tibble' should be created.

Value

A visual table.

Examples

library(CohortCharacteristics)

cdm <- mockCohortCharacteristics()

cdm$cohort2 |>
  summariseCohortAttrition() |>
  tableCohortAttrition()