From e27fb3e63d00979ca3cf21ffc582aac622481d45 Mon Sep 17 00:00:00 2001 From: Zhao Date: Tue, 10 Feb 2026 16:57:53 -0500 Subject: [PATCH 1/6] Enrich documentation details for sim_fixed_n --- R/sim_fixed_n.R | 14 ++++++++++++++ man/sim_fixed_n.Rd | 13 +++++++++++++ 2 files changed, 27 insertions(+) diff --git a/R/sim_fixed_n.R b/R/sim_fixed_n.R index c573111a..c2022498 100644 --- a/R/sim_fixed_n.R +++ b/R/sim_fixed_n.R @@ -51,6 +51,20 @@ #' (1 and 2). #' - `5`: The maximum of targeted event count and minimum follow-up cuts #' (2 and 3). +#' +#' For custom timing options beyond the 5 predefined ones above, +#' please use [sim_pw_surv()] function to generate time-to-event data +#' and [get_analysis_date()] to calculate timing. +#' Refer to https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html +#' for a detailed tutorial. +#' +#' Beyond the logrank or weighted logrank (Fleming-Harrington) tests, +#' the following are supported: RMST via [rmst()], weighted logrank tests +#' via [wlr()] (including Fleming-Harrington, Magirr-Burman, and Xu2017 weights), +#' and MaxCombo test via [maxcombo()]. +#' Refer to https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html +#' for a detailed tutorial. +#' #' #' @return #' A data frame including columns: diff --git a/man/sim_fixed_n.Rd b/man/sim_fixed_n.Rd index 76642a14..d6b03ed9 100644 --- a/man/sim_fixed_n.Rd +++ b/man/sim_fixed_n.Rd @@ -80,6 +80,19 @@ for data cutoff: \item \code{5}: The maximum of targeted event count and minimum follow-up cuts (2 and 3). } + +For custom timing options beyond the 5 predefined ones above, +see the \code{\link[=sim_pw_surv]{sim_pw_surv()}} function to generate time-to-event data +and \code{\link[=get_analysis_date]{get_analysis_date()}} to calculate timing. +Refer to \url{https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html} +for a detailed tutorial. + +Beyond the logrank or weighted logrank (Fleming-Harrington) tests, +the following are supported: RMST via \code{\link[=rmst]{rmst()}}, weighted logrank tests +via \code{\link[=wlr]{wlr()}} (including Fleming-Harrington, Magirr-Burman, and Xu2017 weights), +and MaxCombo test via \code{\link[=maxcombo]{maxcombo()}}. +Refer to \url{https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html} +for a detailed tutorial. } \examples{ \dontshow{if (requireNamespace("dplyr", quietly = TRUE)) withAutoprint(\{ # examplesIf} From 662fa1ff2b1913abb07d2008e097212d22415f60 Mon Sep 17 00:00:00 2001 From: Yujie Zhao <43153957+LittleBeannie@users.noreply.github.com> Date: Wed, 11 Feb 2026 12:08:17 -0500 Subject: [PATCH 2/6] Update R/sim_fixed_n.R Co-authored-by: John Blischak --- R/sim_fixed_n.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/sim_fixed_n.R b/R/sim_fixed_n.R index c2022498..b6f632c8 100644 --- a/R/sim_fixed_n.R +++ b/R/sim_fixed_n.R @@ -53,7 +53,7 @@ #' (2 and 3). #' #' For custom timing options beyond the 5 predefined ones above, -#' please use [sim_pw_surv()] function to generate time-to-event data +#' please instead use [sim_pw_surv()] function to generate time-to-event data #' and [get_analysis_date()] to calculate timing. #' Refer to https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html #' for a detailed tutorial. From 8250649a020629e0c35cbcaa9bc82265bd09ba73 Mon Sep 17 00:00:00 2001 From: Yujie Zhao <43153957+LittleBeannie@users.noreply.github.com> Date: Wed, 11 Feb 2026 12:08:55 -0500 Subject: [PATCH 3/6] Update R/sim_fixed_n.R -- edit vignette link1 Co-authored-by: John Blischak --- R/sim_fixed_n.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/sim_fixed_n.R b/R/sim_fixed_n.R index b6f632c8..b93c76f1 100644 --- a/R/sim_fixed_n.R +++ b/R/sim_fixed_n.R @@ -55,7 +55,7 @@ #' For custom timing options beyond the 5 predefined ones above, #' please instead use [sim_pw_surv()] function to generate time-to-event data #' and [get_analysis_date()] to calculate timing. -#' Refer to https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html +#' Refer to the vignette on [Custom Fixed Design Simulations](https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html) #' for a detailed tutorial. #' #' Beyond the logrank or weighted logrank (Fleming-Harrington) tests, From 1dc55703b79aeba80439a4943a351d473f7aaeed Mon Sep 17 00:00:00 2001 From: Yujie Zhao <43153957+LittleBeannie@users.noreply.github.com> Date: Wed, 11 Feb 2026 12:09:09 -0500 Subject: [PATCH 4/6] Update R/sim_fixed_n.R -- edit vignette link2 Co-authored-by: John Blischak --- R/sim_fixed_n.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/sim_fixed_n.R b/R/sim_fixed_n.R index b93c76f1..d7669beb 100644 --- a/R/sim_fixed_n.R +++ b/R/sim_fixed_n.R @@ -62,7 +62,7 @@ #' the following are supported: RMST via [rmst()], weighted logrank tests #' via [wlr()] (including Fleming-Harrington, Magirr-Burman, and Xu2017 weights), #' and MaxCombo test via [maxcombo()]. -#' Refer to https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html +#' Refer to the vignette on [Custom Fixed Design Simulations](https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html) #' for a detailed tutorial. #' #' From aaf846505b84c9fc3f5e56cae07cf126e6658249 Mon Sep 17 00:00:00 2001 From: Yujie Zhao <43153957+LittleBeannie@users.noreply.github.com> Date: Wed, 11 Feb 2026 12:10:27 -0500 Subject: [PATCH 5/6] Update R/sim_fixed_n.R - improve the wording where more testing are supported in the pkg Co-authored-by: John Blischak --- R/sim_fixed_n.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/R/sim_fixed_n.R b/R/sim_fixed_n.R index d7669beb..edd5f90e 100644 --- a/R/sim_fixed_n.R +++ b/R/sim_fixed_n.R @@ -58,8 +58,8 @@ #' Refer to the vignette on [Custom Fixed Design Simulations](https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html) #' for a detailed tutorial. #' -#' Beyond the logrank or weighted logrank (Fleming-Harrington) tests, -#' the following are supported: RMST via [rmst()], weighted logrank tests +#' If you are doing a custom fixed design simulation, you are not limited to the logrank or weighted logrank (Fleming-Harrington) tests. +#' The following are supported: RMST via [rmst()], weighted logrank tests #' via [wlr()] (including Fleming-Harrington, Magirr-Burman, and Xu2017 weights), #' and MaxCombo test via [maxcombo()]. #' Refer to the vignette on [Custom Fixed Design Simulations](https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html) From 88cd17ab80673a0003b0bcfe60a6bc7dbc7b1846 Mon Sep 17 00:00:00 2001 From: Zhao Date: Wed, 11 Feb 2026 13:19:02 -0500 Subject: [PATCH 6/6] Update Rd file for sim_fixed_n with latest documentation changes --- man/sim_fixed_n.Rd | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/man/sim_fixed_n.Rd b/man/sim_fixed_n.Rd index d6b03ed9..b74688ed 100644 --- a/man/sim_fixed_n.Rd +++ b/man/sim_fixed_n.Rd @@ -82,16 +82,16 @@ for data cutoff: } For custom timing options beyond the 5 predefined ones above, -see the \code{\link[=sim_pw_surv]{sim_pw_surv()}} function to generate time-to-event data +please instead use \code{\link[=sim_pw_surv]{sim_pw_surv()}} function to generate time-to-event data and \code{\link[=get_analysis_date]{get_analysis_date()}} to calculate timing. -Refer to \url{https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html} +Refer to the vignette on \href{https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html}{Custom Fixed Design Simulations} for a detailed tutorial. -Beyond the logrank or weighted logrank (Fleming-Harrington) tests, -the following are supported: RMST via \code{\link[=rmst]{rmst()}}, weighted logrank tests +If you are doing a custom fixed design simulation, you are not limited to the logrank or weighted logrank (Fleming-Harrington) tests. +The following are supported: RMST via \code{\link[=rmst]{rmst()}}, weighted logrank tests via \code{\link[=wlr]{wlr()}} (including Fleming-Harrington, Magirr-Burman, and Xu2017 weights), and MaxCombo test via \code{\link[=maxcombo]{maxcombo()}}. -Refer to \url{https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html} +Refer to the vignette on \href{https://merck.github.io/simtrial/articles/sim_fixed_design_custom.html}{Custom Fixed Design Simulations} for a detailed tutorial. } \examples{