Format a drug_utilisation object into a visual table.
Usage
tableDrugUtilisation(
result,
header = c("cdm_name"),
groupColumn = c("cohort_name", strataColumns(result)),
type = NULL,
hide = c("variable_level", "censor_date", "cohort_table_name", "gap_era", "index_date",
"restrict_incident"),
style = NULL,
.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
Character string specifying the desired output table format. See
visOmopResults::tableType()for supported table types. If type =NULL, global options (set viavisOmopResults::setGlobalTableOptions()) will be used if available; otherwise, a default 'gt' table is created.- hide
Columns to hide from the visualisation. See options with
availableTableColumns(result).- style
Defines the visual formatting of the table. This argument can be provided in one of the following ways:
Pre-defined style: Use the name of a built-in style (e.g., "darwin"). See
visOmopResults::tableStyle()for available options.YAML file path: Provide the path to an existing .yml file defining a new style.
List of custome R code: Supply a block of custom R code or a named list describing styles for each table section. This code must be specific to the selected table type.
If style =
NULL, the function will use global options (seevisOmopResults::setGlobalTableOptions()) or an existing_brand.ymlfile (if found); otherwise, the default style is applied. For more details, see the Styles vignette in visOmopResults website.- .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
# }