diff --git a/R/sim_gs_n.R b/R/sim_gs_n.R index d9b31123..6e2ab41b 100644 --- a/R/sim_gs_n.R +++ b/R/sim_gs_n.R @@ -22,7 +22,7 @@ #' arguments will change as we add additional features. #' #' @inheritParams sim_fixed_n -#' @param tests One or more test functions such as [wlr()], [maxcombo()], or +#' @param test One or more test functions such as [wlr()], [maxcombo()], or #' [rmst()]. If a single test function is provided, it will be applied at each #' cut. Alternatively a list of functions created by [create_test()]. The list #' form is experimental and currently limited. It only accepts one test per @@ -31,8 +31,8 @@ #' flexible in the future). Importantly, note that the simulated data set is #' always passed as the first positional argument to each test function #' provided. -#' @param cuts A list of cutting functions created by [create_cut()], -#' see examples. +#' @param cut A list of cutting functions created by [create_cut()], see +#' examples. #' @param seed Random seed. #' @param ... Arguments passed to the test function(s) provided by the argument #' `tests`. diff --git a/man/sim_gs_n.Rd b/man/sim_gs_n.Rd index a9f28787..4036b3c2 100644 --- a/man/sim_gs_n.Rd +++ b/man/sim_gs_n.Rd @@ -36,12 +36,7 @@ for experimental vs. control, and dropout rates by stratum and time period.} \item{block}{As in \code{\link[=sim_pw_surv]{sim_pw_surv()}}. Vector of treatments to be included in each block.} -\item{seed}{Random seed.} - -\item{...}{Arguments passed to the test function(s) provided by the argument -\code{tests}.} - -\item{tests}{One or more test functions such as \code{\link[=wlr]{wlr()}}, \code{\link[=maxcombo]{maxcombo()}}, or +\item{test}{One or more test functions such as \code{\link[=wlr]{wlr()}}, \code{\link[=maxcombo]{maxcombo()}}, or \code{\link[=rmst]{rmst()}}. If a single test function is provided, it will be applied at each cut. Alternatively a list of functions created by \code{\link[=create_test]{create_test()}}. The list form is experimental and currently limited. It only accepts one test per @@ -51,8 +46,13 @@ flexible in the future). Importantly, note that the simulated data set is always passed as the first positional argument to each test function provided.} -\item{cuts}{A list of cutting functions created by \code{\link[=create_cut]{create_cut()}}, -see examples.} +\item{cut}{A list of cutting functions created by \code{\link[=create_cut]{create_cut()}}, see +examples.} + +\item{seed}{Random seed.} + +\item{...}{Arguments passed to the test function(s) provided by the argument +\code{tests}.} } \value{ A data frame summarizing the simulation ID, analysis date,