adds ExpHazOS function

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(ExpHazOS)
 export(ExpQuantOS)
 export(ExpSurvOS)
 export(ExpSurvPFS)

R/hazardFunctions.R

@@ -0,0 +1,21 @@
+#' OS Hazard Function from Constant Transition Hazards
+#'
+#' @param t (`numeric`)\cr study time-points.
+#' @param h01 (positive `number`)\cr transition hazard for 0 to 1 transition.
+#' @param h02 (positive `number`)\cr transition hazard for 0 to 2 transition.
+#' @param h12 (positive `number`)\cr transition hazard for 1 to 2 transition.
+#'
+#' @return This returns the value of the OS hazard function at time t.
+#' @export
+#'
+#' @examples
+#' ExpHazOS(c(1:5), 0.2, 1.1, 0.8)
+ExpHazOS <- function(t, h01, h02, h12) {
+  assert_numeric(t, lower = 0, any.missing = FALSE)
+  assert_positive_number(h01)
+  assert_positive_number(h02)
+  assert_positive_number(h12)
+
+  h012 <- h12 - h01 - h02
+  ((h12 - h02) * (h01 + h02) - h01 * h12 * exp(-h012 * t)) / ((h12 - h02) - h01 * exp(-h012 * t))
+}

_pkgdown.yaml

@@ -63,3 +63,6 @@ reference:
       - PWCsurvPFS
       - PwcOSInt
       - PWCsurvOS
+  - title: Hazard functions
+    contents:
+      - ExpHazOS

tests/testthat/test-hazardFunctions.R

@@ -0,0 +1,15 @@
+# ExpHazOS ----
+
+test_that("ExpHazOS works as expected", {
+  actual <- ExpHazOS(1, 0.2, 1.1, 0.8)
+  expect_equal(actual, 1.038192, tolerance = 1e-3)
+
+  actual2 <- ExpHazOS(2, 0.4, 1.4, 0.1)
+  expect_equal(actual2, 0.266345, tolerance = 1e-3)
+})
+
+test_that("ExpHazOS works also with vector of times t", {
+  result <- ExpHazOS(t = c(1:3), 0.2, 1.1, 0.8)
+  expected <- c(1.0381919, 0.9777975, 0.9253826)
+  expect_equal(result, expected, tolerance = 1e-3)
+})