-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathdes_gs_bern.Rd
152 lines (135 loc) · 6.15 KB
/
des_gs_bern.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/des_gs_bern.R
\name{des_gs_bern}
\alias{des_gs_bern}
\title{Design a multi-stage group-sequential multi-arm clinical trial for a
Bernoulli distributed primary outcome}
\usage{
des_gs_bern(
K = 2,
J = 2,
alpha = 0.025,
beta = 0.1,
pi0 = 0.3,
delta1 = 0.2,
delta0 = 0,
ratio = 1,
power = "marginal",
stopping = "simultaneous",
type = "variable",
fshape = "pocock",
eshape = "pocock",
ffix = -3,
efix = 3,
spacing = (1:J)/J,
integer = FALSE,
summary = FALSE
)
}
\arguments{
\item{K}{A \code{\link{numeric}} indicating the chosen value for
\ifelse{html}{\out{<i>K</i>}}{\eqn{K}}, the (initial) number of experimental
treatment arms. Defaults to \code{2}.}
\item{J}{A \code{\link{numeric}} indicating the chosen value for
\ifelse{html}{\out{<i>J</i>}}{\eqn{J}}, the (maximum) number of allowed
stages. Defaults to \code{2}.}
\item{alpha}{A \code{\link{numeric}} indicating the chosen value for
\ifelse{html}{\out{<i>α</i>}}{\eqn{\alpha}}, the significance level
(family-wise error-rate). Defaults to \code{0.025}.}
\item{beta}{A \code{\link{numeric}} indicating the chosen value for
\ifelse{html}{\out{<i>β</i>}}{\eqn{\beta}}, used in the definition of
the desired power. Defaults to \code{0.1}.}
\item{pi0}{A \code{\link{numeric}} indicating the chosen value for
\ifelse{html}{\out{<i>π</i><sub>0</sub>}}{\eqn{\pi_0}}, the
response rate in the control arm. Defaults to \code{0.3}.}
\item{delta1}{A \code{\link{numeric}} indicating the chosen value for
\ifelse{html}{\out{<i>δ</i><sub>1</sub>}}{\eqn{\delta_1}}, the
'interesting' treatment effect. Defaults to \code{0.5}.}
\item{delta0}{A \code{\link{numeric}} indicating the chosen value for
\ifelse{html}{\out{<i>δ</i><sub>0</sub>}}{\eqn{\delta_0}}, the
'uninteresting' treatment effect. Defaults to \code{0}.}
\item{ratio}{A \code{\link{numeric}} indicating the chosen value for
\ifelse{html}{\out{<i>r</i>}}{\eqn{r}}, the stage-wise allocation ratio to
present experimental arms. Defaults to \code{1}.}
\item{power}{A \code{\link{character}} string indicating the chosen type of
power to design the trial for. Can be \code{"disjunctive"} or
\code{"marginal"}. Defaults to \code{"marginal"}.}
\item{stopping}{A \code{\link{character}} string indicating the chosen type
of stopping rule. Can be \code{"separate"} or \code{"simultaneous"}. Defaults
to \code{"simultaneous"}.}
\item{type}{A \code{\link{character}} string indicating the choice for the
stage-wise sample size. Can be \code{"variable"} or \code{"fixed"}. Defaults
to \code{"variable"}.}
\item{fshape}{A \code{\link{character}} string indicating the choice for the
futility (lower) stopping boundaries. Can be any of \code{"fixed"},
\code{"obf"}, \code{"pocock"}, and \code{"triangular"}. Defaults to
\code{"pocock"}.}
\item{eshape}{A \code{\link{character}} string indicating the choice for the
efficacy (upper) stopping boundaries. Can be any of \code{"fixed"},
\code{"obf"}, \code{"pocock"}, and \code{"triangular"}. Defaults to
\code{"pocock"}.}
\item{ffix}{A \code{\link{numeric}} indicating the chosen value for the fixed
interim futility bounds. Only used when \code{fshape = "fixed"}. Defaults to
\code{"-3"}.}
\item{efix}{A \code{\link{numeric}} indicating the chosen value for the fixed
interim efficacy bounds. Only used when \code{eshape = "fixed"}. Defaults to
\code{"3"}.}
\item{spacing}{A \code{\link{numeric}} \code{\link{vector}} indicating the
chosen spacing of the interim analyses in terms of the proportion of the
maximal possible sample size. It must contain strictly increasing values,
with final element equal to \code{1}. Defaults to
\code{(1:J)/J} (i.e., to equally spaced analyses).}
\item{integer}{A \code{\link{logical}} variable indicating whether the
computed possible sample sizes required in each arm in each stage should be
forced to be whole numbers. Defaults to \code{FALSE}. WARNING: If you set
\code{integer = TRUE} and \code{ratio != 1}, obscure results can occur due to
difficulties in identifying a suitable whole number sample size that meets
the allocation ratio requirement.}
\item{summary}{A \code{\link{logical}} variable indicating whether a summary
of the function's progress should be printed to the console. Defaults to
\code{FALSE}.}
}
\value{
A \code{\link{list}}, with additional class
\code{"multiarm_des_gs_bern"}, containing the following elements:
\itemize{
\item A \code{\link{tibble}} in the slot \code{$opchar} summarising the
operating characteristics of the identified design.
\item A \code{\link{tibble}} in the slot \code{$pmf_N} summarising the
probability mass function of the random required sample size under key
scenarios.
\item A \code{\link{numeric}} \code{\link{vector}} in the slot \code{$e}
specifying \ifelse{html}{\out{<b><i>e</i></b>}}{\eqn{\bold{e}}}, the trial's
efficacy (upper) stopping boundaries.
\item A \code{\link{numeric}} \code{\link{vector}} in the slot \code{$f}
specifying \ifelse{html}{\out{<b><i>f</i></b>}}{\eqn{\bold{f}}}, the trial's
futility (lower) stopping boundaries.
\item A \code{\link{numeric}} in the slot \code{$maxN} specifying
\ifelse{html}{\out{max <i>N</i>}}{max \eqn{N}}, the trial's maximum required
sample size.
\item A \code{\link{numeric}} in the slot \code{$n_factor}, for internal use
in other functions.
\item A \code{\link{numeric}} in the slot \code{$n1} specifying
\ifelse{html}{\out{<i>n</i><sub>1</sub>}}{\eqn{n_1}}, the total sample size
required in stage one of the trial.
\item A \code{\link{numeric}} in the slot \code{$n10} specifying
\ifelse{html}{\out{<i>n</i><sub>10</sub>}}{\eqn{n_{10}}}, the sample size
required in the control arm in stage one of the trial.
\item Each of the input variables.
}
}
\description{
\code{des_gs_bern()} determines multi-stage group-sequential multi-arm
clinical trial designs assuming the primary outcome variable is Bernoulli
distributed. It computes required design components and returns information
on key operating characteristics.
}
\examples{
# The design for the default parameters
des <- des_gs_bern()
}
\seealso{
\code{\link{build_gs_bern}}, \code{\link{gui}},
\code{\link{opchar_gs_bern}}, \code{\link{plot.multiarm_des_gs_bern}},
\code{\link{sim_gs_bern}}.
}