formatCharacteristics {PatientProfiles} | R Documentation |
Format a summarised_characteristics object into a visual table.
Description
'r lifecycle::badge("deprecated")'
Usage
formatCharacteristics(
result,
type = "gt",
splitStrata = TRUE,
format = c(`N (%)` = "<count> (<percentage>%)", N = "<count>",
"<median> [<q25> - <q75>]", "<mean> (<sd>)", range = "<min> to <max>"),
cdmName = TRUE,
cohortName = TRUE,
style = "default",
minCellCount = 5,
.options = list()
)
Arguments
result |
A summarised_characteristics object. |
type |
Type of desired formatted table, possibilities: "gt", "flextable", "tibble". |
splitStrata |
Whether or not to split the strata, default is True. |
format |
The columns that the user wishes to see for the formatted table. |
cdmName |
Whether or not to display the cdm name, default is TRUE. |
cohortName |
Weather or not to display the cohort name, default is TRUE. |
style |
The style of the table output. |
minCellCount |
Default is 5, meaning results that are more than 0 but less than 5 will not be reported. |
.options |
See optionsTableCharacteristics() for default values. |
Value
A tibble with a tidy version of the summarised_characteristics object.
Examples
library(PatientProfiles)
cdm <- mockPatientProfiles()
cdm$cohort1 |>
summariseCharacteristics()
CDMConnector::cdmDisconnect(cdm = cdm)
[Package PatientProfiles version 0.8.0 Index]