des_gs: Design a group-sequential clinical trial for a normally...

Description Usage Arguments Value See Also Examples

View source: R/des_gs.R

Description

des_gs() determines (non-optimised) group-sequential clinical trial designs assuming the primary outcome variable is normally distributed. It supports a variety of popular boundary shapes: Haybittle-Peto, power-family, triangular, and Wang-Tsiatis (which includes O'Brien-Fleming and Pocock) designs.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
des_gs(
  J = 2,
  alpha = 0.05,
  beta = 0.2,
  delta = 0.2,
  sigma0 = 1,
  sigma1 = sigma0,
  ratio = 1,
  shape = "power_family",
  Delta = 0,
  quantile_sub = FALSE,
  integer_n = TRUE,
  summary = FALSE
)

Arguments

J

A numeric indicating the chosen value for J, the maximal allowed number of stages. Must be an integer greater than or equal to 2. Defaults to 2.

alpha

A numeric indicating the chosen value for α, the desired type-I error-rate. Must be strictly between 0 and 1. Defaults to 0.05.

beta

A numeric indicating the chosen value for β, the desired type-II error-rate. Must be strictly between 0 and 1. Defaults to 0.2.

delta

A numeric indicating the chosen value for δ, the treatment effect to power the trial for. Must be strictly positive. Defaults to 0.2.

sigma0

A numeric indicating the chosen value for σ0, the standard deviation of the responses in the control arm. Must be strictly positive. Defaults to 1.

sigma1

A numeric indicating the chosen value for σ1, the standard deviation of the responses in the experimental arm. Must be strictly positive. Defaults to sigma0.

ratio

A numeric indicating the chosen value for r, the allocation ratio to the experimental arm relative to the control arm. Must be strictly positive. Defaults to 1.

shape

A character string indicating the chosen stopping boundary shape. Must be one of "haybittle_peto", "obrien_fleming", "pocock", "power_family", "triangular", or "wang_tsiatis". Defaults to "power_family".

Delta

Only used if shape is equal to "power_family" or "wang_tsiatis". Then, it is a numeric (potentially a numeric vector) indicating the boundary shape parameter(s). Specifically, for shape = "wang_tsiatis" it should be a single numeric, while for shape = "power_family" it can be a numeric vector of length 1 or 2. Defaults to 0.

quantile_sub

A logical variable indicating whether quantile substitution should be applied to the identified stopping boundaries. Defaults to FALSE.

integer_n

A logical variable indicating whether the computed values for n0 and n1, the group sizes in the control and experimental arms, should be forced to be whole numbers. Defaults to TRUE.

summary

A logical variable indicating whether a summary of the function's progress should be printed to the console. Defaults to FALSE.

Value

A list with additional class "OptGS_des". It will contain each of the input variables (subject to internal modification), relating them to the outputs of the various group-sequential design functions in OptGS, along with additional elements including:

See Also

build, des_nearopt, des_opt, est, opchar, sim, plot.OptGS_des, print.OptGS_des, summary.OptGS_des

Examples

1
2
3
4
5
6
# The group-sequential design for the default parameters
des     <- des_gs()
# A three-stage design
des_3   <- des_gs(J = 3)
# With triangular-test boundaries
des_tri <- des_gs(shape = "triangular")

mjg211/OptGS documentation built on May 28, 2021, 3:44 p.m.