Format a summarised_treatment result 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 <- cdm$cohort1 |>
summariseTreatment(
treatmentCohortName = "cohort2",
window = list(c(0, 30), c(31, 365))
)
#> ℹ Intersect with medications table (cohort2)
#> ℹ Summarising medications.
tableTreatment(result)
#> cdm_name, cohort_name, variable_name, window_name, censor_date,
#> cohort_table_name, index_date, mutually_exclusive, and treatment_cohort_name
#> are missing in `columnOrder`, will be added last.
Medication from index date to 30 days after
Medication from 31 days after to 365 days after the index date
# }