-
Notifications
You must be signed in to change notification settings - Fork 5
/
build_dtl_norm.R
147 lines (138 loc) · 6.94 KB
/
build_dtl_norm.R
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
#' Build a multi-stage drop-the-losers multi-arm clinical trial for a normally
#' distributed primary outcome
#'
#' \code{build_dtl_norm()} builds a multi-stage drop-the-losers multi-arm
#' clinical trial design object assuming the primary outcome variable is
#' normally distributed, like those returned by \code{\link{des_dtl_norm}}.
#'
#' @param n1 A \code{\link{numeric}} indicating the chosen value for
#' \ifelse{html}{\out{<i>n</i><sub>1</sub>}}{\eqn{n_1}}, the total sample size
#' required in stage one of the trial. Defaults to \code{147}.
#' @param n10 A \code{\link{numeric}} indicating the chosen value for
#' \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. Defaults to \code{49}.
#' @param e A \code{\link{numeric}} indicating the chosen value for
#' \ifelse{html}{\out{<i>e</i>}}{\eqn{e}}, the critical rejection boundary for
#' the final analysis. Defaults to \code{2.17}.
#' @param Kv A \code{\link{numeric}} \code{\link{vector}} of strictly decreasing
#' values, indicating the chosen value for
#' \ifelse{html}{\out{<b><i>K</i></b>}}{\eqn{\bold{K}}}, the number of
#' experimental treatment arms present in each stage. Defaults to
#' \code{c(2, 1)}.
#' @param 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}.
#' @param 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}.
#' @param 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}.
#' @param 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}.
#' @param sigma A \code{\link{numeric}} \code{\link{vector}} indicating the
#' chosen values for
#' \ifelse{html}{\out{<i>σ</i><sub>0</sub>}}{\eqn{\sigma_0}} and
#' \ifelse{html}{\out{<i>σ</i><sub>1</sub>}}{\eqn{\sigma_1}}, the standard
#' deviations of the responses in the control and experimental arms. Must be of
#' \code{\link{length}} 1 or 2. If of \code{\link{length}} 1, it is assumed that
#' \ifelse{html}{\out{<i>σ</i><sub>0</sub>
#' =<i>σ</i><sub>1</sub>}}{\eqn{\sigma_0=\sigma_1}}.
#' Defaults to \code{1}.
#' @param 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}.
#' @param 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"}.
#' @param 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"}.
#' @param 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}.
#' @return A \code{\link{list}}, with additional class
#' \code{"multiarm_des_dtl_norm"}, 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{numeric}} in the slot \code{$maxN} specifying
#' \ifelse{html}{\out{<i>N</i>}}{\eqn{N}}, the trial's total required sample
#' size.
#' \item A \code{\link{numeric}} in the slot \code{$n_factor}, for internal use
#' in other functions.
#' \item Each of the input variables.
#' }
#' @examples
#' # The design for the default parameters
#' des <- build_dtl_norm()
#' @seealso \code{\link{des_dtl_norm}}, \code{\link{gui}},
#' \code{\link{opchar_dtl_norm}}, \code{\link{plot.multiarm_des_dtl_norm}},
#' \code{\link{sim_dtl_norm}}.
#' @export
build_dtl_norm <- function(n1 = 147, n10 = 49, e = 2.17, Kv = c(2, 1),
alpha = 0.025, beta = 0.1, delta1 = 0.5, delta0 = 0,
sigma = 1, ratio = 1, power = "marginal",
type = "variable", summary = FALSE) {
##### Check input variables ##################################################
#check_n1_n10(n1, n10, "n1", "n10", int = F)
check_real_range_strict(e, "e", c(-Inf, Inf), 1)
Kv <- check_Kv(Kv, "Kv")
J <- length(Kv)
check_real_range_strict(alpha, "alpha", c(0, 1), 1)
check_real_range_strict(beta, "beta", c(0, 1), 1)
check_delta0_delta1(delta0, delta1, "delta0", "delta1")
sigma <- check_sigma(sigma, name_sigma = "sigma", des = "mams")
check_real_range_strict(ratio, "ratio", c(0, Inf), 1)
check_belong(power, "power", c("disjunctive", "marginal"), 1)
check_belong(type, "type", c("fixed", "variable"), 1)
check_logical(summary, "summary")
##### Print summary ##########################################################
if (summary) {
#summary_build_dtl_norm(n1, n10, e, Kv, alpha, beta, delta1, delta0, sigma,
# ratio, power, stopping, type)
message("")
}
##### Perform main computations ##############################################
if (summary) {
message(" Building outputs..")
}
integer <- all(c(n1, n10)%%1 == 0)
if (type == "variable") {
n_factor <- n10
} else {
n_factor <- n1
}
comp <- components_dtl_init(alpha, beta, delta0, delta1, integer, Kv,
power, ratio, summary, type, sigma,
n_factor = n_factor, e = e)
tau <- rbind(numeric(Kv[1]), rep(delta1, Kv[1]),
matrix(delta0, Kv[1], Kv[1]) +
(delta1 - delta0)*diag(Kv[1]))
comp <- components_dtl_update(comp, tau)
comp <- opchar_dtl_internal(comp)
##### Outputting #############################################################
if (summary) {
message("..outputting.")
}
output <- list(alpha = alpha,
beta = beta,
delta0 = delta0,
delta1 = delta1,
e = e,
integer = integer,
Kv = Kv,
maxN = comp$opchar$maxN[1],
n_factor = n_factor,
n1 = n1,
n10 = n10,
opchar = comp$opchar,
power = power,
ratio = ratio,
sigma = sigma,
summary = summary,
type = type)
class(output) <- c("multiarm_des_dtl_norm", class(output))
output
}