Merge pull request #245 from Merck/no-suggests

Run code conditionally to pass `noSuggests` check

Author: nanxstats

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: simtrial
 Type: Package
 Title: Clinical Trial Simulation
-Version: 0.4.0
+Version: 0.4.1
 Authors@R: c(
     person("Keaven", "Anderson", email = "keaven_anderson@merck.com", role = c("aut")),
     person("Yujie", "Zhao", email = "yujie.zhao@merck.com", role =  c("ctb","cre")),
@@ -44,6 +44,7 @@ Imports:
     future,
     methods,
     mvtnorm,
+    rlang,
     stats,
     survival,
     utils

NAMESPACE

@@ -42,6 +42,7 @@ importFrom(future,plan)
 importFrom(methods,is)
 importFrom(mvtnorm,GenzBretz)
 importFrom(mvtnorm,pmvnorm)
+importFrom(rlang,is_installed)
 importFrom(survival,Surv)
 importFrom(survival,is.Surv)
 importFrom(survival,survfit)

NEWS.md

@@ -1,3 +1,10 @@
+# simtrial 0.4.1
+
+## Improvements
+
+- Pass `noSuggests` checks by running code examples, tests, and vignettes
+  conditionally if the `Suggests` dependencies are not installed (#243).
+
 # simtrial 0.4.0
 
 ## New features
@@ -56,8 +63,7 @@ performance substantially, and adds new features and documentation.
 - Complete overhaul of the API. Function and argument names now use
   snake case for consistency and readability. See the
   [function reference](https://merck.github.io/simtrial/reference/)
-  for the updated naming scheme. Detailed change history is available in the
-  [merged pull requests](https://github.com/Merck/simtrial/pulls?q=is%3Apr+is%3Aclosed)
+  for the updated naming scheme. Detailed change history is available in the merged pull requests
   (thanks, @LittleBeannie, @lili-ling-msd, and @XintongLi2023).
 - Dataset names updated to snake case (thanks, @nanxstats, #164).
 - The base pipe operator is now used throughout the package.

R/get_analysis_date.R

@@ -69,9 +69,8 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("gsDesign2")
 #' library(gsDesign2)
-#' library(simtrial)
 #'
 #' alpha <- 0.025
 #' ratio <- 3

R/get_cut_date_by_event.R

@@ -29,7 +29,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("dplyr")
 #' library(dplyr)
 #'
 #' # Use default enrollment and calendar cut date

R/mb_delayed_effect.R

@@ -38,7 +38,6 @@
 #'
 #' @examples
 #' library(survival)
-#' library(dplyr)
 #'
 #' fit <- survfit(Surv(tte, event) ~ treatment, data = mb_delayed_effect)
 #'

R/randomize_by_fixed_block.R

@@ -32,7 +32,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("dplyr")
 #' library(dplyr)
 #'
 #' # Example 1

R/sim_fixed_n.R

@@ -73,7 +73,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("dplyr")
 #' library(dplyr)
 #' library(future)
 #'

R/sim_gs_n.R

@@ -42,7 +42,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("gsDesign2")
 #' library(gsDesign2)
 #'
 #' # Parameters for enrollment

R/sim_pw_surv.R

@@ -60,7 +60,7 @@
 #'
 #' @export
 #'
-#' @examples
+#' @examplesIf rlang::is_installed("dplyr")
 #' library(dplyr)
 #'
 #' # Example 1