Merge pull request #479 from tidymodels/bring-survival-back

Bring survival metrics back back
tidymodels · Jan 18, 2024 · 6104423 · 6104423
2 parents 81e2cc6 + aa4a6b4
commit 6104423
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 10 deletions.
diff --git a/R/surv-brier_survival.R b/R/surv-brier_survival.R
@@ -63,7 +63,6 @@
 #'     truth = surv_obj,
 #'     .pred
 #'   )
-#' @keywords internal
 #' @export
 brier_survival <- function(data, ...) {
   UseMethod("brier_survival")

diff --git a/R/surv-brier_survival_integrated.R b/R/surv-brier_survival_integrated.R
@@ -51,7 +51,6 @@
 #'     truth = surv_obj,
 #'     .pred
 #'   )
-#' @keywords internal
 #' @export
 brier_survival_integrated <- function(data, ...) {
   UseMethod("brier_survival_integrated")

diff --git a/R/surv-concordance_survival.R b/R/surv-concordance_survival.R
@@ -49,7 +49,6 @@
 #'   truth = surv_obj,
 #'   estimate = .pred_time
 #' )
-#' @keywords internal
 #' @export
 concordance_survival <- function(data, ...) {
   UseMethod("concordance_survival")

diff --git a/R/surv-roc_auc_survival.R b/R/surv-roc_auc_survival.R
@@ -55,7 +55,6 @@
 #'     truth = surv_obj,
 #'     .pred
 #'   )
-#' @keywords internal
 #' @export
 roc_auc_survival <- function(data, ...) {
   UseMethod("roc_auc_survival")

diff --git a/R/surv-roc_curve_survival.R b/R/surv-roc_curve_survival.R
@@ -76,7 +76,6 @@
 #'
 #' # Or use autoplot
 #' autoplot(result)
-#' @keywords internal
 #' @export
 roc_curve_survival <- function(data, ...) {
   UseMethod("roc_curve_survival")

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -75,6 +75,20 @@ reference:
     - equalized_odds
     - equal_opportunity
 
+  - title: Dynamic Survival Metrics
+    contents:
+    - brier_survival
+    - brier_survival_integrated
+    - roc_auc_survival
+
+  - title: Static Survival Metrics
+    contents:
+    - concordance_survival
+
+  - title: Curve Survival Functions
+    contents:
+    - roc_curve_survival
+
   - title: Curve Functions
     contents:
     - roc_curve

diff --git a/man/brier_survival.Rd b/man/brier_survival.Rd
diff --git a/man/brier_survival_integrated.Rd b/man/brier_survival_integrated.Rd
diff --git a/man/concordance_survival.Rd b/man/concordance_survival.Rd
diff --git a/man/roc_auc_survival.Rd b/man/roc_auc_survival.Rd
diff --git a/man/roc_curve_survival.Rd b/man/roc_curve_survival.Rd