Format a summarise_characteristics object into a visual table.
Source:R/tableCharacteristics.R
tableCharacteristics.Rd![[Experimental]](figures/lifecycle-experimental.svg)
Usage
tableCharacteristics(
result,
type = "gt",
header = c("cdm_name", "cohort_name"),
groupColumn = character(),
hide = c(additionalColumns(result), settingsColumns(result)),
style = "default",
.options = list()
)Arguments
- result
A summarised_result object.
- type
Type of table. Check supported types with
visOmopResults::tableType().- header
Columns to use as header. See options with
availableTableColumns(result).- groupColumn
Columns to group by. See options with
availableTableColumns(result).- hide
Columns to hide from the visualisation. See options with
availableTableColumns(result).- style
Named list that specifies how to style the different parts of the table generated. It can either be a pre-defined style ("default" or "darwin" - the latter just for gt and flextable), NULL to get the table default style, or custom. Keep in mind that styling code is different for all table styles. To see the different styles see
visOmopResults::tableStyle().- .options
A named list with additional formatting options.
visOmopResults::tableOptions()shows allowed arguments and their default values.
Examples
# \donttest{
library(CohortCharacteristics)
cdm <- mockCohortCharacteristics()
result <- summariseCharacteristics(cdm$cohort1)
#> ℹ adding demographics columns
#> ℹ summarising data
#> ℹ summarising cohort cohort_1
#> ℹ summarising cohort cohort_2
#> ℹ summarising cohort cohort_3
#> ✔ summariseCharacteristics finished!
tableCharacteristics(result)
# }