feat: add fall out alias for FPR

overdodactyl · Jan 5, 2024 · 713a3a6 · 713a3a6
1 parent af56ea2
commit 713a3a6
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/R/dx_metrics.R b/R/dx_metrics.R
@@ -179,7 +179,8 @@ dx_fnr <- function(cm, detail = "full", ...) {
 #'
 #' The formula for FPR is:
 #' \deqn{FPR = \frac{False Positives}{False Positives + True Negatives}}{FPR = FP / (FP + TN)}
-#'
+#' @aliases dx_fall_out
+#' @name fpr
 #' @examples
 #' cm <- dx_cm(dx_heart_failure$predicted, dx_heart_failure$truth, threshold =
 #'             0.5, poslabel = 1)
@@ -195,6 +196,9 @@ dx_fpr <- function(cm, detail = "full", ...) {
   metric_binomial(cm$fp, cm$disneg, name = "False Positive Rate", detail = detail, ...)
 }
 
+#' @rdname fpr
+dx_fall_out <- dx_fpr
+
 #' Calculate False Discovery Rate (FDR)
 #'
 #' Calculates the False Discovery Rate (FDR), which is the proportion of false positives

diff --git a/man/dx_fpr.Rd → man/fpr.Rd b/man/dx_fpr.Rd → man/fpr.Rd