chevron (version 0.2.7)

dst01_main: DST01 Table 1 (Default) Patient Disposition Table 1.

Description

The DST01 Disposition Table provides an overview of patients study completion. For patients who discontinued the study a reason is provided.

Usage

dst01_main(
  adam_db,
  arm_var = "ARM",
  lbl_overall = "All {Patient_label}",
  study_status_var = "EOSSTT",
  detail_vars = list(Discontinued = c("DCSREAS")),
  trt_status_var = NULL,
  ...
)
dst01_pre(adam_db, ...)
dst01_post(tlg, prune_0 = TRUE, ...)
dst01

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 chevron_t of length 1.

Arguments

adam_db

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

arm_var

(string) variable. Usually one of ARM, ACTARM, TRT01A, or TRT01A.

lbl_overall

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

study_status_var

(string) variable used to define patient status. Default is EOSSTT, however can also be a variable name with the pattern EOPxxSTT where xx must be substituted by 2 digits referring to the analysis period.

detail_vars

Named (list) of grouped display of study_status_var. The names must be subset of unique levels of study_status_var.

trt_status_var

(string) variable of treatment status.

...

not used.

tlg

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

prune_0

(flag) remove 0 count rows

Functions

• dst01_main(): Main TLG function

• dst01_pre(): Preprocessing

• dst01_post(): Postprocessing

Details

• Default patient disposition table summarizing the reasons for patients withdrawal.

• Numbers represent absolute numbers of patients and fraction of N.

• Remove zero-count rows.

• Split columns by arm.

• Include a total column by default.

• Sort withdrawal reasons by alphabetic order.

Examples

run(dst01, syn_data, detail_vars = list(Ongoing = "STDONS"))

run(dst01, syn_data, detail_vars = list(Discontinued = "DCSREAS", Ongoing = "STDONS"))

run(
  dst01, syn_data,
  detail_vars = list(
    Discontinued = c("DCSREASGP", "DCSREAS"),
    Ongoing = "STDONS"
  )
)