tableCharacteristics {CohortCharacteristics} | R Documentation |
Format a summarise_characteristics object into a visual table.
Description
Usage
tableCharacteristics(
result,
type = "gt",
header = c("cdm_name", "cohort_name"),
groupColumn = character(),
hide = c(additionalColumns(result), settingsColumns(result)),
.options = list()
)
Arguments
result |
A summarised_result object. |
type |
Type of table. Check supported types with
|
header |
Columns to use as header. See options with
|
groupColumn |
Columns to group by. See options with
|
hide |
Columns to hide from the visualisation. See options with
|
.options |
A named list with additional formatting options.
|
Value
A formatted table.
Examples
library(CohortCharacteristics)
cdm <- mockCohortCharacteristics()
result <- summariseCharacteristics(cdm$cohort1)
tableCharacteristics(result)
mockDisconnect(cdm)
[Package CohortCharacteristics version 1.0.0 Index]