Add vignette on group sequential testing with rpact

NEWS.md

@@ -80,3 +80,4 @@
 * Added `graph_test_shortcut_gsDesign()`, which performs the group sequential graphical procedure of `graph_test_shortcut_gsd()` with all group sequential calculations (boundaries and repeated p-values) delegated to the gsDesign package, using gsDesign's spending functions (`sfu`, `sfupar`) and spending time (`usTime`). gsDesign is a suggested package and is only required by this function
 * Added a vignette on group sequential testing with `graph_test_shortcut_gsDesign()`, which reproduces the case studies of the group sequential testing vignette with gsDesign's spending functions and spending time
 * Added `graph_test_shortcut_rpact()`, which performs the same group sequential graphical procedure with all group sequential calculations delegated to the rpact package, using rpact's design types and parameters (`typeOfDesign`, `gammaA`, `deltaWT`, `userAlphaSpending`) and an optional spending time. rpact is a suggested package and is only required by this function
+* Added a vignette on group sequential testing with `graph_test_shortcut_rpact()`, which reproduces the case studies of the group sequential testing vignette with rpact's design types and spending time, and shows how rpact is used inside the function

R/graph_test_shortcut_rpact.R

@@ -90,9 +90,11 @@
 #'   design at the information fractions, divided by their maximum when they
 #'   exceed 1 (the correlation between analyses depends only on their
 #'   ratios). The classical boundary families are defined by their boundary
-#'   shape over the whole planned schedule, and rpact requires their final
-#'   information fraction to be exactly 1: unlike the alpha spending designs,
-#'   they cannot be given only the analyses conducted so far.
+#'   shape over the whole planned schedule — their constant is calibrated so
+#'   that the crossing probability over all planned analyses equals the level
+#'   — so their final information fraction must be exactly 1 (rpact enforces
+#'   this, as does [spending_wt()]): unlike the alpha spending designs, they
+#'   cannot be given only the analyses conducted so far.
 #' * **Single-analysis hypotheses.** A hypothesis with one analysis below
 #'   full information uses the first stage of a two-stage design ending at 1,
 #'   so that its boundary is the cumulative spending at that information
@@ -397,9 +399,10 @@ gsd_input_val_rpact <- function(typeOfDesign, gammaA, deltaWT,
     if (type %in% gsd_rpact_classical && length(t_j) > 1 &&
       !isTRUE(all.equal(t_j[length(t_j)], 1))) {
       stop(
-        "rpact requires the final information fraction to be exactly 1 for ",
-        "the classical boundary families (\"", type, "\" for hypothesis ", j,
-        "): supply the full planned schedule."
+        "The classical boundary families are defined over the whole planned ",
+        "schedule, so the final information fraction must be exactly 1 (\"",
+        type, "\" for hypothesis ", j, "): supply the full planned schedule, ",
+        "or use an alpha spending design for analyses conducted so far."
       )
     }
   }

_pkgdown.yml

@@ -99,6 +99,7 @@ articles:
   - closed-testing
   - group-sequential-testing
   - group-sequential-testing-gsDesign
+  - group-sequential-testing-rpact
   - graph-examples
   - internal-validation
   - comparisons

inst/WORDLIST

@@ -9,6 +9,7 @@ Bonferroni
 Brannath
 Bretz
 Cani
+Cham
 Childress
 Csardi
 De
@@ -87,6 +88,7 @@ funder
 gMCP
 gMCPLite
 gatekeeping
+graphicalMCP's
 gsDesign
 gsDesign's
 igraph
@@ -110,6 +112,7 @@ rescale
 rescales
 rightarrow
 rpact
+rpact's
 stagewise
 successiveness
 th