update define_enroll_rate documentation

Merck · Jan 3, 2024 · 21c623e · 21c623e
1 parent 69b34ae
commit 21c623e
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/R/define.R b/R/define.R
@@ -18,6 +18,10 @@
 
 #' Define enrollment rate
 #'
+#' The function define subject enrollment rate for a study.
+#' It also supports stratified design that have different enrollment rate in
+#' each stratum.
+#'
 #' @param duration A numeric vector of piecewise study duration interval.
 #' @param rate A numeric vector of enrollment rate in each `duration`.
 #' @param stratum A character vector of stratum name.
@@ -74,7 +78,7 @@ define_enroll_rate <- function(
   df
 }
 
-#' Define fail rate
+#' Define failure rate
 #'
 #' The function define subject failure rate for a study with two treatment groups.
 #' It also supports stratified design that have different failure rate in

diff --git a/man/define_enroll_rate.Rd b/man/define_enroll_rate.Rd
diff --git a/man/define_fail_rate.Rd b/man/define_fail_rate.Rd