View source: R/gsBinomialExact.R
gsBinomialExact | R Documentation |
gsBinomialExact
computes power/Type I error and expected sample size
for a group sequential design in a single-arm trial with a binary outcome.
This can also be used to compare event rates in two-arm studies. The print
function has been extended using print.gsBinomialExact
to print
gsBinomialExact
objects. Similarly, a plot function has
been extended using plot.gsBinomialExact
to plot
gsBinomialExact
objects.
binomialSPRT
computes a truncated binomial sequential probability
ratio test (SPRT) which is a specific instance of an exact binomial group
sequential design for a single arm trial with a binary outcome.
gsBinomialPP
computes a truncated binomial (group) sequential design
based on predictive probability.
nBinomial1Sample
uses exact binomial calculations to compute power
and sample size for single arm binomial experiments.
gsBinomialExact
is based on the book "Group Sequential Methods with
Applications to Clinical Trials," Christopher Jennison and Bruce W.
Turnbull, Chapter 12, Section 12.1.2 Exact Calculations for Binary Data.
This computation is often used as an approximation for the distribution of
the number of events in one treatment group out of all events when the
probability of an event is small and sample size is large.
An object of class gsBinomialExact
is returned. On output, the values
of theta
input to gsBinomialExact
will be the parameter values
for which the boundary crossing probabilities and expected sample sizes are
computed.
Note that a[1] equal to -1 lower bound at n.I[1] means 0 successes continues at interim 1; a[2]==0 at interim 2 means 0 successes stops trial for futility at 2nd analysis. For final analysis, set a[k] equal to b[k]-1 to incorporate all possibilities into non-positive trial; see example.
The sequential probability ratio test (SPRT) is a sequential testing scheme
allowing testing after each observation. This likelihood ratio is used to
determine upper and lower cutoffs which are linear and parallel in the
number of responses as a function of sample size. binomialSPRT
produces a variation the the SPRT that tests only within a range of sample
sizes. While the linear SPRT bounds are continuous, actual bounds are the
integer number of response at or beyond each linear bound for each sample
size where testing is performed. Because of the truncation and
discretization of the bounds, power and Type I error achieve will be lower
than the nominal levels specified by alpha
and beta
which can
be altered to produce desired values that are achieved by the planned sample
size. See also example that shows computation of Type I error when futility
bound is considered non-binding.
Note that if the objective of a design is to demonstrate that a rate (e.g.,
failure rate) is lower than a certain level, two approaches can be taken.
First, 1 minus the failure rate is the success rate and this can be used for
planning. Second, the role of beta
becomes to express Type I error
and alpha
is used to express Type II error.
Plots produced include boundary plots, expected sample size, response rate at the boundary and power.
gsBinomial1Sample
uses exact binomial computations based on the base
R functions qbinom()
and pbinom()
. The tabular output may be
convenient for plotting. Note that input variables are largely not checked,
so the user is largely responsible for results; it is a good idea to do a
run with outtype=3
to check that you have done things appropriately.
If n
is not ordered (a bad idea) or not sequential (maybe OK), be
aware of possible consequences.
nBinomial1Sample
is based on code from Marc Schwartz marc_schwartz@me.com.
The possible sample size vector n
needs to be selected in such a fashion
that it covers the possible range of values that include the true minimum.
NOTE: the one-sided evaluation of significance is more conservative than using the 2-sided exact test in binom.test
.
gsBinomialExact(
k = 2,
theta = c(0.1, 0.2),
n.I = c(50, 100),
a = c(3, 7),
b = c(20, 30)
)
binomialSPRT(
p0 = 0.05,
p1 = 0.25,
alpha = 0.1,
beta = 0.15,
minn = 10,
maxn = 35
)
## S3 method for class 'gsBinomialExact'
plot(x, plottype = 1, ...)
## S3 method for class 'binomialSPRT'
plot(x, plottype = 1, ...)
nBinomial1Sample(
p0 = 0.9,
p1 = 0.95,
alpha = 0.025,
beta = NULL,
n = 200:250,
outtype = 1,
conservative = FALSE
)
k |
Number of analyses planned, including interim and final. |
theta |
Vector of possible underling binomial probabilities for a single binomial sample. |
n.I |
Sample size at analyses (increasing positive integers); vector of length k. |
a |
Number of "successes" required to cross lower bound cutoffs to
reject |
b |
Number of "successes" required to cross upper bound cutoffs for
rejecting |
p0 |
Lower of the two response (event) rates hypothesized. |
p1 |
Higher of the two response (event) rates hypothesized. |
alpha |
Nominal probability of rejecting response (event) rate
|
beta |
Nominal probability of rejecting response (event) rate |
minn |
Minimum sample size at which sequential testing begins. |
maxn |
Maximum sample size. |
x |
Item of class |
plottype |
1 produces a plot with counts of response at bounds (for
|
... |
arguments passed through to |
n |
sample sizes to be considered for |
outtype |
Operative when |
conservative |
operative when |
gsBinomialExact()
returns a list of class
gsBinomialExact
and gsProbability
(see example); when
displaying one of these objects, the default function to print is
print.gsProbability()
. The object returned from
gsBinomialExact()
contains the following elements:
k |
As input. |
theta |
As input. |
n.I |
As input. |
lower |
A list
containing two elements: |
upper |
A list of the same form as |
en |
A vector of the same length as |
binomialSPRT
produces an object of class binomialSPRT
that is
an extension of the gsBinomialExact
class. The values returned in
addition to those returned by gsBinomialExact
are:
intercept |
A vector of length 2 with the intercepts for the two SPRT bounds. |
slope |
A scalar with the common slope of the SPRT bounds. |
alpha |
As input. Note that this will exceed the actual Type I error achieved by the design returned. |
beta |
As input. Note that this will exceed the actual Type II error achieved by the design returned. |
p0 |
As input. |
p1 |
As input. |
nBinomial1Sample
produces a data frame with power for each input value in n
if beta=NULL
. Otherwise, a sample size achieving the desired power is returned unless
the minimum power for the values input in n
is greater than or equal to the target or
the maximum yields power less than the target, in which case an error message is shown.
The input variable outtype
has no effect if beta=NULL
.
Otherwise, outtype=1
results in return of an integer sample size and outtype=2
results in a data frame with one record which includes the desired sample size.
When a data frame is returned, the variables include:
p0 |
Input null hypothesis event (or response) rate. |
p1 |
Input alternative hypothesis
(or response) rate; must be |
alpha |
Input Type I error. |
beta |
Input Type II error except when input is |
n |
sample size. |
b |
cutoff given |
alphaR |
Type I error achieved for each
output value of |
Power |
Power achieved
for each output value of |
The gsDesign technical manual is available at https://keaven.github.io/gsd-tech-manual/.
Jon Hartzel, Yevgen Tymofyeyev and Keaven Anderson keaven_anderson@merck.com
Jennison C and Turnbull BW (2000), Group Sequential Methods with Applications to Clinical Trials. Boca Raton: Chapman and Hall.
Code for nBinomial1Sample was based on code developed by marc_schwartz@me.com.
gsProbability
library(ggplot2)
zz <- gsBinomialExact(
k = 3, theta = seq(0.1, 0.9, 0.1), n.I = c(12, 24, 36),
a = c(-1, 0, 11), b = c(5, 9, 12)
)
# let's see what class this is
class(zz)
# because of "gsProbability" class above, following is equivalent to
# \code{print.gsProbability(zz)}
zz
# also plot (see also plots below for \code{binomialSPRT})
# add lines using geom_line()
plot(zz) +
ggplot2::geom_line()
# now for SPRT examples
x <- binomialSPRT(p0 = .05, p1 = .25, alpha = .1, beta = .2)
# boundary plot
plot(x)
# power plot
plot(x, plottype = 2)
# Response (event) rate at boundary
plot(x, plottype = 3)
# Expected sample size at boundary crossing or end of trial
plot(x, plottype = 6)
# sample size for single arm exact binomial
# plot of table of power by sample size
# note that outtype need not be specified if beta is NULL
nb1 <- nBinomial1Sample(p0 = 0.05, p1=0.2,alpha = 0.025, beta=NULL, n = 25:40)
nb1
library(scales)
ggplot2::ggplot(nb1, ggplot2::aes(x = n, y = Power)) +
ggplot2::geom_line() +
ggplot2::geom_point() +
ggplot2::scale_y_continuous(labels = percent)
# simple call with same parameters to get minimum sample size yielding desired power
nBinomial1Sample(p0 = 0.05, p1 = 0.2, alpha = 0.025, beta = .2, n = 25:40)
# change to 'conservative' if you want all larger sample
# sizes to also provide adequate power
nBinomial1Sample(p0 = 0.05, p1 = 0.2, alpha = 0.025, beta = .2, n = 25:40, conservative = TRUE)
# print out more information for the selected derived sample size
nBinomial1Sample(p0 = 0.05, p1 = 0.2, alpha = 0.025, beta = .2, n = 25:40, conservative = TRUE,
outtype = 2)
# Reproduce realized Type I error alphaR
stats::pbinom(q = 5, size = 39, prob = .05, lower.tail = FALSE)
# Reproduce realized power
stats::pbinom(q = 5, size = 39, prob = 0.2, lower.tail = FALSE)
# Reproduce critical value for positive finding
stats::qbinom(p = 1 - .025, size = 39, prob = .05) + 1
# Compute p-value for 7 successes
stats::pbinom(q = 6, size = 39, prob = .05, lower.tail = FALSE)
# what happens if input sample sizes not sufficient?
## Not run:
nBinomial1Sample(p0 = 0.05, p1 = 0.2, alpha = 0.025, beta = .2, n = 25:30)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.