chevron (version 0.2.7)

cmt01_label: CMT01A Concomitant Medication by Medication Class and Preferred Name.

Description

A concomitant medication table with the number of subjects and the total number of treatments by medication class.

Usage

cmt01_label
cmt01a_main(
  adam_db,
  arm_var = "ARM",
  lbl_overall = NULL,
  row_split_var = "ATC2",
  medname_var = "CMDECOD",
  summary_labels = setNames(rep(list(cmt01_label), length(row_split_var) + 1L),
    c("TOTAL", row_split_var)),
  ...
)
cmt01a_pre(adam_db, ...)
cmt01a_post(
  tlg,
  prune_0 = TRUE,
  sort_by_freq = FALSE,
  row_split_var = "ATC2",
  medname_var = "CMDECOD",
  ...
)
cmt01a

Value

the main function returns an rtables object.

the preprocessing function returns a list of data.frame.

the postprocessing function returns an rtables object or an ElementaryTable (null report).

Format

An object of class character of length 2.

An object of class chevron_t of length 1.

Arguments

adam_db

(list of data.frames) object containing the ADaM datasets

arm_var

(string) variable used for column splitting

lbl_overall

(string) label used for overall column, if set to NULL the overall column is omitted

row_split_var

(character) the variable defining the medication category. By default ATC2.

medname_var

(string) variable name of medical treatment name.

summary_labels

(list) of summarize labels. See details.

...

not used.

tlg

(TableTree, Listing or ggplot) object typically produced by a main function.

prune_0

(flag) remove 0 count rows

sort_by_freq

(flag) whether to sort medication class by frequency.

Functions

• cmt01_label: Default labels

• cmt01a_main(): Main TLG function

• cmt01a_pre(): Preprocessing

• cmt01a_post(): Postprocessing

Details

• Data should be filtered for concomitant medication. (ATIREL == "CONCOMITANT").

• Numbers represent absolute numbers of subjects and fraction of N, or absolute numbers when specified.

• Remove zero-count rows unless overridden with prune_0 = FALSE.

• Split columns by arm.

• Does not include a total column by default.

• Sort by medication class alphabetically and within medication class by decreasing total number of patients with the specific medication. summary_labels is used to control the summary for each level. If "all" is used, then each split will have that summary statistic with the labels. One special case is "TOTAL", this is for the overall population.

Examples

library(dplyr)

proc_data <- syn_data
proc_data$adcm <- proc_data$adcm %>%
  filter(ATIREL == "CONCOMITANT")

run(cmt01a, proc_data)