Format a drug_utilisation object into a visual table.
Usage
tableDrugUtilisation(
result,
header = c("cdm_name"),
groupColumn = c("cohort_name", strataColumns(result)),
type = "gt",
hide = c("variable_level", "censor_date", "cohort_table_name", "gap_era", "index_date",
"restrict_incident"),
style = "default",
.options = list()
)Arguments
- result
A summarised_result object.
- header
Columns to use as header. See options with
availableTableColumns(result).- groupColumn
Columns to group by. See options with
availableTableColumns(result).- type
Type of table. Check supported types with
visOmopResults::tableType().- 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 use
visOmopResults::tableStyle().- .options
A named list with additional formatting options.
visOmopResults::tableOptions()shows allowed arguments and their default values.
Examples
# \donttest{
library(DrugUtilisation)
library(CodelistGenerator)
cdm <- mockDrugUtilisation()
codelist <- getDrugIngredientCodes(cdm = cdm, name = "acetaminophen")
cdm <- generateDrugUtilisationCohortSet(cdm = cdm,
name = "dus_cohort",
conceptSet = codelist)
#> ℹ Subsetting drug_exposure table
#> ℹ Checking whether any record needs to be dropped.
#> ℹ Collapsing overlaping records.
#> ℹ Collapsing records with gapEra = 1 days.
drugUse <- cdm$dus_cohort |>
summariseDrugUtilisation(ingredientConceptId = 1125315)
tableDrugUtilisation(drugUse)
#> cdm_name, cohort_name, variable_level, censor_date, cohort_table_name, gap_era,
#> index_date, and restrict_incident are missing in `columnOrder`, will be added
#> last.
161_acetaminophen
# }