Skip to content

Commit c180105

Browse files
committed
Revise according to CoPilot's comments
1 parent 8884345 commit c180105

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

R/gs_power_npe.R

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,41 +18,41 @@
1818

1919
#' @title Group sequential design computation with non-constant effect and information.
2020
#'
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,
2222
#' 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
2424
#' 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)
2727
#' non-constant effect, 2) more flexibility in boundary selection.
2828
#'
2929
#' \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
3131
#' method of deriving bounds, such as spending.
3232
#'
3333
#' \code{gs_design_npe()} derives group sequential design size,
3434
#' bounds and boundary crossing probabilities based on proportionate
3535
#' information and effect size at analyses, as well as the
3636
#' method of deriving bounds, such as spending.
3737
#'
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()}.
4040
#'
4141
#' @param theta Natural parameter for group sequential design representing
4242
#' expected cumulative drift at all analyses; used for power calculation.
4343
#' 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`.
4545
#' @param theta0 Natural parameter for null hypothesis.
4646
#' 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.
4848
#' @param theta1 Natural parameter for alternate hypothesis,
4949
#' if needed for lower bound computation.
5050
#' It can be a scalar (constant treatment effect) or a vector (non-constant treatment effect).
5151
#' The default is the same as `theta`, which yields the usual beta-spending.
5252
#' If set to 0, spending is 2-sided under the null hypothesis.
5353
#' @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`.
5656
#' @param info0 Statistical information under null hypothesis.
5757
#' It is a vector of all positive numbers with increasing order.
5858
#' Default is set to be the same as `info`.
@@ -96,8 +96,8 @@
9696
#' - `theta`: same as the input.
9797
#' - `theta1`: same as the input.
9898
#' - `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.
101101
#' factor to ensure the design has power `1 - beta`.
102102
#' - `info0`: statistical information under the null at each analysis.
103103
#' - `info1`: statistical information under the alternative at each analysis.

man/gs_power_design_npe.Rd

Lines changed: 13 additions & 13 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)