From 9ccf3cbcc47ca33126412e242a946da4d3135749 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Tue, 16 Jan 2024 17:47:22 -0800 Subject: [PATCH 1/2] make survival metrics no longer internal --- R/surv-brier_survival.R | 1 - R/surv-brier_survival_integrated.R | 1 - R/surv-concordance_survival.R | 1 - R/surv-roc_auc_survival.R | 1 - R/surv-roc_curve_survival.R | 1 - man/brier_survival.Rd | 1 - man/brier_survival_integrated.Rd | 1 - man/concordance_survival.Rd | 1 - man/roc_auc_survival.Rd | 1 - man/roc_curve_survival.Rd | 1 - 10 files changed, 10 deletions(-) diff --git a/R/surv-brier_survival.R b/R/surv-brier_survival.R index 8903fee0..e3aebad4 100644 --- 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 index 6a5157a5..3e40f273 100644 --- 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 index 25836fd7..49f73161 100644 --- 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 index 071929ac..6d7fa143 100644 --- 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 index 8ecaf4fc..6ac25c38 100644 --- 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/man/brier_survival.Rd b/man/brier_survival.Rd index c583423b..34b4ae1e 100644 --- a/man/brier_survival.Rd +++ b/man/brier_survival.Rd @@ -100,4 +100,3 @@ Other dynamic survival metrics: Emil Hvitfeldt } \concept{dynamic survival metrics} -\keyword{internal} diff --git a/man/brier_survival_integrated.Rd b/man/brier_survival_integrated.Rd index f2961147..af2b8220 100644 --- a/man/brier_survival_integrated.Rd +++ b/man/brier_survival_integrated.Rd @@ -112,4 +112,3 @@ Other dynamic survival metrics: Emil Hvitfeldt } \concept{dynamic survival metrics} -\keyword{internal} diff --git a/man/concordance_survival.Rd b/man/concordance_survival.Rd index 45688a5b..967a2303 100644 --- a/man/concordance_survival.Rd +++ b/man/concordance_survival.Rd @@ -98,4 +98,3 @@ Medicine, 15(4), 361-87, 1996. Emil Hvitfeldt } \concept{static survival metrics} -\keyword{internal} diff --git a/man/roc_auc_survival.Rd b/man/roc_auc_survival.Rd index a6c899ec..039fe2e1 100644 --- a/man/roc_auc_survival.Rd +++ b/man/roc_auc_survival.Rd @@ -107,4 +107,3 @@ Other dynamic survival metrics: Emil Hvitfeldt } \concept{dynamic survival metrics} -\keyword{internal} diff --git a/man/roc_curve_survival.Rd b/man/roc_curve_survival.Rd index 817154d0..5d63877c 100644 --- a/man/roc_curve_survival.Rd +++ b/man/roc_curve_survival.Rd @@ -107,4 +107,3 @@ Compute the area under the ROC survival curve with \code{\link[=roc_auc_survival Emil Hvitfeldt } \concept{survival curve metrics} -\keyword{internal} From aa4a6b4faa00cfc12625306509e7eb8b0ff20a21 Mon Sep 17 00:00:00 2001 From: Emil Hvitfeldt Date: Tue, 16 Jan 2024 17:59:04 -0800 Subject: [PATCH 2/2] add survival metrics to _pkgdown.yml --- _pkgdown.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/_pkgdown.yml b/_pkgdown.yml index dc43cead..162c7f9d 100644 --- 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