Skip to contents

Teal Module: Patient Profile Therapy Teal Module

Source: R/tm_g_pp_therapy.R
tm_g_pp_therapy.Rd

This teal module produces a patient profile therapy plot using ADaM datasets.

Usage 

tm_g_pp_therapy(
  label,
  dataname = "ADCM",
  parentname = "ADSL",
  patient_col = "USUBJID",
  atirel = NULL,
  cmdecod = NULL,
  cmindc = NULL,
  cmdose = NULL,
  cmtrt = NULL,
  cmdosu = NULL,
  cmroute = NULL,
  cmdosfrq = NULL,
  cmstdy = NULL,
  cmendy = NULL,
  font_size = c(12L, 12L, 25L),
  plot_height = c(700L, 200L, 2000L),
  plot_width = NULL,
  pre_output = NULL,
  post_output = NULL,
  ggplot2_args = teal.widgets::ggplot2_args()
)

Arguments

label

(character)
menu item label of the module in the teal app.

dataname

(character)
analysis data used in teal module.

parentname

(character)
parent analysis data used in teal module, usually this refers to ADSL.

patient_col

(character)
patient ID column to be used.

atirel

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
ATIREL column of the ADCM dataset.

cmdecod

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMDECOD column of the ADCM dataset.

cmindc

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMINDC column of the ADCM dataset.

cmdose

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMDOSE column of the ADCM dataset.

cmtrt

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMTRT column of the ADCM dataset.

cmdosu

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMDOSU column of the ADCM dataset.

cmroute

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMROUTE column of the ADCM dataset.

cmdosfrq

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMDOSFRQ column of the ADCM dataset.

cmstdy

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMSTDY column of the ADCM dataset.

cmendy

(teal.transform::choices_selected() or teal.transform::data_extract_spec())
CMENDY column of the ADCM dataset.

font_size

(numeric)
numeric vector of length 3 for current, min and max font size values.

plot_height

optional, (numeric)
a vector of length three with c(value, min, max). Specifies the height of the main plot and renders a slider on the plot to interactively adjust the plot height.

plot_width

optional, (numeric)
a vector of length three with c(value, min, max). Specifies the width of the main plot and renders a slider on the plot to interactively adjust the plot width.

pre_output

optional, (shiny.tag)
with text placed before the output to put the output into context. For example a title.

post_output

optional, (shiny.tag)
with text placed after the output to put the output into context. For example the shiny::helpText() elements are useful.

ggplot2_args

optional, (ggplot2_args)
object created by teal.widgets::ggplot2_args() with settings for the module plot. The argument is merged with option teal.ggplot2_args and with default module arguments (hard coded in the module body).

For more details, see the help vignette: vignette("custom-ggplot2-arguments", package = "teal.widgets").

Examples 

library(nestcolor)

adcm <- tmc_ex_adcm
adsl <- tmc_ex_adsl %>% dplyr::filter(USUBJID %in% adcm$USUBJID)
adcm$CMASTDTM <- adcm$ASTDTM
adcm$CMAENDTM <- adcm$AENDTM
adcm_keys <- c("STUDYID", "USUBJID", "ASTDTM", "CMSEQ", "ATC1", "ATC2", "ATC3", "ATC4")

app <- init(
  data = cdisc_data(
    cdisc_dataset("ADSL", adsl),
    cdisc_dataset("ADCM", adcm, keys = adcm_keys)
  ),
  modules = modules(
    tm_g_pp_therapy(
      label = "Therapy",
      dataname = "ADCM",
      parentname = "ADSL",
      patient_col = "USUBJID",
      plot_height = c(600L, 200L, 2000L),
      atirel = choices_selected(
        choices = variable_choices(adcm, "ATIREL"),
        selected = c("ATIREL")
      ),
      cmdecod = choices_selected(
        choices = variable_choices(adcm, "CMDECOD"),
        selected = "CMDECOD"
      ),
      cmindc = choices_selected(
        choices = variable_choices(adcm, "CMINDC"),
        selected = "CMINDC"
      ),
      cmdose = choices_selected(
        choices = variable_choices(adcm, "CMDOSE"),
        selected = "CMDOSE"
      ),
      cmtrt = choices_selected(
        choices = variable_choices(adcm, "CMTRT"),
        selected = "CMTRT"
      ),
      cmdosu = choices_selected(
        choices = variable_choices(adcm, "CMDOSU"),
        selected = c("CMDOSU")
      ),
      cmroute = choices_selected(
        choices = variable_choices(adcm, "CMROUTE"),
        selected = "CMROUTE"
      ),
      cmdosfrq = choices_selected(
        choices = variable_choices(adcm, "CMDOSFRQ"),
        selected = "CMDOSFRQ"
      ),
      cmstdy = choices_selected(
        choices = variable_choices(adcm, "ASTDY"),
        selected = "ASTDY"
      ),
      cmendy = choices_selected(
        choices = variable_choices(adcm, "AENDY"),
        selected = "AENDY"
      )
    )
  )
)
#> [INFO] 2023-08-14 14:44:09.9052 pid:1183 token:[] teal.modules.clinical Initializing tm_g_pp_therapy
if (interactive()) {
  shinyApp(app$ui, app$server)
}