|
18 | 18 |
|
19 | 19 | #' @title Group sequential design computation with non-constant effect and information. |
20 | 20 | #' |
21 | | -#' @description The following 2 functions allows a non-constant treatment effect over time, |
| 21 | +#' @description The following two functions allow a non-constant treatment effect over time, |
22 | 22 | #' but also can be applied for the usual homogeneous effect size designs. |
23 | | -#' They requires treatment effect and statistical information at each analysis |
| 23 | +#' They require treatment effect and statistical information at each analysis |
24 | 24 | #' as well as a method of deriving bounds, such as spending. |
25 | | -#' Initial bound types supported are spending bounds, and fixed bounds. |
26 | | -#' The above routine enables two things not available in the gsDesign package: 1) |
| 25 | +#' Initial bound types supported are spending bounds and fixed bounds. |
| 26 | +#' These routines enables two things not available in the gsDesign package: 1) |
27 | 27 | #' non-constant effect, 2) more flexibility in boundary selection. |
28 | 28 | #' |
29 | 29 | #' \code{gs_power_npe()} derives group sequential bounds and boundary crossing probabilities |
30 | | -#' for a design, given treatment effect and information at each analysis, as well as the |
| 30 | +#' for a design, given treatment effect and information at each analysis and the |
31 | 31 | #' method of deriving bounds, such as spending. |
32 | 32 | #' |
33 | 33 | #' \code{gs_design_npe()} derives group sequential design size, |
34 | 34 | #' bounds and boundary crossing probabilities based on proportionate |
35 | 35 | #' information and effect size at analyses, as well as the |
36 | 36 | #' method of deriving bounds, such as spending. |
37 | 37 | #' |
38 | | -#' The only differences in arguments of the 2 functions are the \code{alpha} and \code{beta} |
39 | | -#' used in the \code{gs_design_npe()}. |
| 38 | +#' The only differences in arguments between the two functions are the \code{alpha} and \code{beta} |
| 39 | +#' parameters used in the \code{gs_design_npe()}. |
40 | 40 | #' |
41 | 41 | #' @param theta Natural parameter for group sequential design representing |
42 | 42 | #' expected cumulative drift at all analyses; used for power calculation. |
43 | 43 | #' It can be a scalar (constant treatment effect) or a vector (non-constant treatment effect). |
44 | | -#' Users are required to provide the value of `theta`. |
| 44 | +#' The user must provide a value for `theta`. |
45 | 45 | #' @param theta0 Natural parameter for null hypothesis. |
46 | 46 | #' It can be a scalar (constant treatment effect) or a vector (non-constant treatment effect). |
47 | | -#' Default is 0. If users provide values other than 0, it impacts upper bound computation. |
| 47 | +#' The default is 0. If a value other than 0 is provided, it affects upper bound computation. |
48 | 48 | #' @param theta1 Natural parameter for alternate hypothesis, |
49 | 49 | #' if needed for lower bound computation. |
50 | 50 | #' It can be a scalar (constant treatment effect) or a vector (non-constant treatment effect). |
51 | 51 | #' The default is the same as `theta`, which yields the usual beta-spending. |
52 | 52 | #' If set to 0, spending is 2-sided under the null hypothesis. |
53 | 53 | #' @param info Statistical information at all analyses for input `theta`. |
54 | | -#' It is a vector of all positive numbers with increasing order. |
55 | | -#' Users are required to input it corresponding to `theta`. |
| 54 | +#' It is a vector of positive numbers in increasing order. |
| 55 | +#' The user must provide values corresponding to `theta`. |
56 | 56 | #' @param info0 Statistical information under null hypothesis. |
57 | 57 | #' It is a vector of all positive numbers with increasing order. |
58 | 58 | #' Default is set to be the same as `info`. |
|
96 | 96 | #' - `theta`: same as the input. |
97 | 97 | #' - `theta1`: same as the input. |
98 | 98 | #' - `info`: statistical information at each analysis. |
99 | | -#' + If it is returned by `gs_power_npe`, the `info`, `info0`, `info1` is same as the input. |
100 | | -#' + If it is returned by `gs_design_npe`, the `info`, `info0`, `info1` is change by some constant scale |
| 99 | +#' + If it is returned by `gs_power_npe`, the `info`, `info0`, `info1` are same as the input. |
| 100 | +#' + If it is returned by `gs_design_npe`, the `info`, `info0`, `info1` are changed by a constant scale factor. |
101 | 101 | #' factor to ensure the design has power `1 - beta`. |
102 | 102 | #' - `info0`: statistical information under the null at each analysis. |
103 | 103 | #' - `info1`: statistical information under the alternative at each analysis. |
|
0 commit comments