R/cmt02_pt.R

In chevron: Standard TLGs for Clinical Trials Reporting

# cmt02_pt ----

#' @describeIn cmt02_pt Main TLG function
#'
#' @inherit cmt01a_main
#' @include cmt01a.R
#' @returns the main function returns an `rtables` object.
#' @export
#'
cmt02_pt_main <- modify_default_args(
  cmt01a_main,
  row_split_var = NULL,
  summary_labels = quote(list(TOTAL = cmt01_label))
)

#' @describeIn cmt02_pt Preprocessing
#'
#' @inherit cmt01a_pre
#' @returns the preprocessing function returns a `list` of `data.frame`.
#' @export
#'
cmt02_pt_pre <- cmt01a_pre

#' @describeIn cmt02_pt Postprocessing
#'
#' @inherit cmt01a_post
#' @returns the postprocessing function returns an `rtables` object or an `ElementaryTable` (null report).
#' @export
#'
cmt02_pt_post <- modify_default_args(cmt01a_post, row_split_var = NULL)

#' `CMT02_PT` Table 1 (Default) Concomitant Medications by Preferred Name.
#'
#' A concomitant medication table with the
#' number of subjects and the total number of treatments by medication name sorted by frequencies.
#'
#' @include chevron_tlg-S4class.R
#' @export
#'
#' @examples
#' run(cmt02_pt, syn_data)
cmt02_pt <- chevron_t(
  main = cmt02_pt_main,
  preprocess = cmt02_pt_pre,
  postprocess = cmt02_pt_post,
  dataset = c("adsl", "adcm")
)