Skip to contents

Format a summarised_treatment result into a visual table.

Usage

tableTreatment(
  result,
  header = c("cdm_name", "cohort_name"),
  groupColumn = "variable_name",
  type = "gt",
  hide = c("window_name", "mutually_exclusive", "censor_date", "cohort_table_name",
    "index_date", "treatment_cohort_name"),
  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.

Value

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

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.
CDM name
DUS MOCK
Treatment Estimate name
Cohort name
cohort_1 cohort_2 cohort_3
Medication from index date to 30 days after
cohort_1 N (%) 2 (66.67 %) 0 (0.00 %) 0 (0.00 %)
cohort_2 N (%) 0 (0.00 %) 2 (40.00 %) 0 (0.00 %)
cohort_3 N (%) 0 (0.00 %) 1 (20.00 %) 0 (0.00 %)
untreated N (%) 1 (33.33 %) 2 (40.00 %) 2 (100.00 %)
not in observation N (%) 0 (0.00 %) 0 (0.00 %) 0 (0.00 %)
Medication from 31 days after to 365 days after the index date
cohort_1 N (%) 2 (66.67 %) 0 (0.00 %) 0 (0.00 %)
cohort_2 N (%) 0 (0.00 %) 2 (40.00 %) 0 (0.00 %)
cohort_3 N (%) 0 (0.00 %) 0 (0.00 %) 0 (0.00 %)
untreated N (%) 1 (33.33 %) 3 (60.00 %) 2 (100.00 %)
not in observation N (%) 0 (0.00 %) 0 (0.00 %) 0 (0.00 %)
# }