Include rmst() formula example ~ Surv(month, evntd, trt)

Merck · Mar 14, 2024 · 3ccb493 · 3ccb493
1 parent 9ed6d32
commit 3ccb493
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 6 deletions.
diff --git a/R/rmst.R b/R/rmst.R
@@ -59,16 +59,27 @@
 #' )
 #'
 #' # Formula interface
+#' library("survival")
+#'
 #' rmst(
-#'   month ~ evntd + trt,
+#'   Surv(month | evntd) ~ trt,
 #'   data = ex1_delayed_effect,
 #'   tau = 10,
 #'   reference = "0"
 #' )
 #'
-#' library("survival")
+#' # alternative
 #' rmst(
-#'   Surv(month | evntd) ~ trt,
+#'   ~ Surv(month, evntd, trt),
+#'   data = ex1_delayed_effect,
+#'   tau = 10,
+#'   reference = "0"
+#' )
+#'
+#' # This example doesn't make statistical sense, but demonstrates that only the
+#' # order of the 3 variables actually matters
+#' rmst(
+#'   month ~ evntd + trt,
 #'   data = ex1_delayed_effect,
 #'   tau = 10,
 #'   reference = "0"

diff --git a/man/rmst.Rd b/man/rmst.Rd
diff --git a/tests/testthat/test-unvalidated-rmst.R b/tests/testthat/test-unvalidated-rmst.R
@@ -44,4 +44,12 @@ test_that("formula method matches default method", {
     reference = "0"
   )
   expect_equal(rmst_formula_2, rmst_default)
+
+  rmst_formula_3 <- rmst(
+    ~ survival::Surv(month, evntd, trt),
+    data = ex1_delayed_effect,
+    tau = 10,
+    reference = "0"
+  )
+  expect_equal(rmst_formula_3, rmst_default)
 })