Format a dose_coverage object into a visual table.
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)
cdm <- mockDrugUtilisation()
result <- summariseDoseCoverage(cdm, 1125315)
#> ℹ The following estimates will be computed:
#> • daily_dose: count_missing, percentage_missing, mean, sd, q25, median, q75
#> ! Table is collected to memory as not all requested estimates are supported on
#> the database side
#> → Start summary of data, at 2025-11-19 17:19:53.948208
#> ✔ Summary finished, at 2025-11-19 17:19:54.376607
tableDoseCoverage(result)
#> cdm_name, ingredient_name, variable_name, variable_level, estimate_name, and
#> sample_size are missing in `columnOrder`, will be added last.
DUS MOCK; acetaminophen
# }