createTreatments: Create Treatment Design Data

In MSToolkit: The MSToolkit library for clinical trial design

Description

Create treatment group for Parallel or Crossover design

Usage

createTreatments(doses, 
  times = NULL, 
  type = "Parallel", 
  sequence, 
  doseCol = getEctdColName("Dose"), 
  timeCol = getEctdColName("Time"), 
  trtCol = getEctdColName("Trt"))

Arguments

doses	(Required) Vector of doses to use. Alternatively can be a comma separated string of numbers
times	(Optional) Vector of time points for dosing. No time element by default
type	(Optional) Type of dosing regime to create: "Parallel" or "Crossover". "Parallel" by default. See "details" section.
sequence	(Optional) Crossover sequence matrix. By default, no crossover is performed. See "details" section.
doseCol	(Optional) Dose variable name to create ("DOSE" by default)
timeCol	(Optional) Time variable name to create ("TIME" by default)
trtCol	(Optional) Treatment variable name to create ("TRT" by default)

Details

The function will first check for the required inputs. If type is "Parallel", then doses must be provided. If type is "Crossover", the sequence matrix must be provided.

If the dose type is "Parallel" and there is are no specified "times", the function will create a data frame with Treatment set to "1 to number of doses" and a Dose variable with the doses specified. If the dose type is "Parallel" and there is a specified "times" vector, the function will create a data frame with a parallel treatment regime for each dose specified.

If the dose type is "Crossover", and there is are no specified "times" input, the "times" input will be set to "1 to number of rows of the sequence matrix" If "times" has been supplied, and has leading non-positive elements, the sequence matrix is appended to a set of run-in measurements (where dose is set to 0). Based on the "times" and "sequence" matrix, a data frame is created by aligning each column of the matrix with the times specified.

Value

A data frame containing a treatment, dose and (optionally) a time variable

Author(s)

Mike K Smith [e-mail]

See Also

allocateTreatments

Examples

createTreatments(doses=c(0, 15, 30))
#  TRT DOSE
#1   1    0
#2   2   15
#3   3   30
createTreatments(doses=c(0, 15, 30), times=0:2)
#  TRT TIME DOSE
#1   1    0    0
#2   1    1    0
#3   1    2    0
#4   2    0    0
#5   2    1   15
#6   2    2   15
#7   3    0    0
#8   3    1   30
#9   3    2   30

createTreatments(sequence=cbind(c(0, 15, 30), c(15, 30, 0), c(30, 0, 15)))
#  TRT TIME DOSE
#1   1    1    0
#2   1    2   15
#3   1    3   30
#4   2    1   15
#5   2    2   30
#6   2    3    0
#7   3    1   30
#8   3    2    0
#9   3    3   15

createTreatments(sequence=cbind(c(0, 15, 30), c(15, 30, 0), c(30, 0, 15)), times=0:3)
#   TRT TIME DOSE
#1    1    0    0
#2    1    1    0
#3    1    2   15
#4    1    3   30
#5    2    0    0
#6    2    1   15
#7    2    2   30
#8    2    3    0
#9    3    0    0
#10   3    1   30
#11   3    2    0
#12   3    3   15

MSToolkit documentation built on May 2, 2019, 6:30 p.m.