Skip to contents

Format a dose_coverage object into a visual table.

Usage

tableDoseCoverage(
  result,
  header = c("variable_name", "estimate_name"),
  groupColumn = c("cdm_name", "ingredient_name"),
  type = "gt",
  hide = c("variable_level", "sample_size"),
  .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).

.options

A named list with additional formatting options. visOmopResults::tableOptions() shows allowed arguments and their default values.

Value

A table with a formatted version of summariseDrugCoverage() results.

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-07-03 14:04:04.260479
#>  Summary finished, at 2025-07-03 14:04:04.691457

tableDoseCoverage(result)
#> Warning: cdm_name, ingredient_name, variable_name, variable_level, estimate_name, and
#> sample_size are missing in `columnOrder`, will be added last.
Variable name
number records
Missing dose
daily_dose
Unit Route Pattern id
Estimate name
N N (%) Mean (SD) Median (Q25 - Q75)
DUS MOCK; acetaminophen
overall overall overall 7 0 (0.00 %) 69,701.82 (180,937.18) 577.44 (23.98 - 3,640.00)
milligram overall overall 7 0 (0.00 %) 69,701.82 (180,937.18) 577.44 (23.98 - 3,640.00)
oral overall 1 0 (0.00 %) - 7.31 (7.31 - 7.31)
topical overall 6 0 (0.00 %) 81,317.57 (195,326.75) 928.72 (173.21 - 4,820.00)
oral 9 1 0 (0.00 %) - 7.31 (7.31 - 7.31)
topical 18 3 0 (0.00 %) 160,619.15 (276,592.15) 1,280.00 (928.72 - 240,640.00)
9 3 0 (0.00 %) 2,015.99 (3,450.29) 38.46 (23.98 - 3,019.23)
# }