subjectGraph: Graph of Dose Adminsitered vs Subject Number

In PuzzledFace/crmReporter: Utility Functions for the Design and Reporting of CRM Trials

Description

The graph indicates toxicity status using colur and, optionally, indicates cohort boundaries and the MTD at the end of the trial

Usage

subjectGraph(
  d,
  x = SubjectID,
  y = Dose,
  cohort = Cohort,
  tox = Toxicity,
  toxColours = NA,
  toxLabels = NA,
  showCohorts = TRUE,
  xLabel = "Subject",
  yLabel = "Dose",
  mtd = NA,
  type = c("crm", "ocrm"),
  ...
)

Arguments

d	a tibble containing subject numbers, dose alloactions and toxicity status. Usually of class "ocrmSubjects" or "crmSubjects".
x	the column in d defining the subject ID
y	the column in d defining the dose
cohort	the column in d defining the cohort
tox	the column in d defining the toxicity status
toxColours	the colours used to identify the DLT status of each subject. See Usage notes below.
toxLabels	the texts used to label the various DLT statuses in the legend. See Usage notes below.
showCohorts	should the graph indentify cohorts by inserting light grey dashed lines between cohorts?
xLabel	the text used to label the x axis
yLabel	the text used to label the y axis
mtd	the dose identified as the MTD at the end of the study. Appears in green at (maxSubject + 0.25, mtd) where maxSubject is the maximum subject number and mtd is the dose identified as the MTD.
type	Optional flag to indicate the type of the trial being plotted. Supported values are "crm" and "ocrm". See Usage notes below.
...	Not currently used

Value

the ggplot2 object containing the plot.

Usage notes

If toxLabels and/or toxColours are specfied, the values supplied are used. Otherwise, the value of type is used to specify the number of toxicity categories and the colours used to represent them. If type == "crm", then toxLabels = c("None", "DLT") and toxColours=c("grey", "red"). If type == "ocrm", then toxLabels = c("None", "Sub-DLT", DLT")} and \code{toxColours=c("grey", "gold", red").

Examples

data(oCRMPatientData)
subjectGraph(oCRMPatientData, type="ocrm")

PuzzledFace/crmReporter documentation built on June 21, 2020, 12:52 a.m.