R/binary_tn.R

Defines functions tn_cm tn

Documented in tn

#' @title True Negatives
#'
#' @details
#' This measure counts the true negatives, i.e. the number of
#' predictions correctly indicating a negative class label. This is sometimes also called a "correct rejection".
#'
#' @templateVar mid tn
#' @template binary_template
#'
#' @references
#' \url{https://en.wikipedia.org/wiki/Template:DiagnosticTesting_Diagram}
#'
#' @inheritParams binary_params
#' @template binary_example
#' @export
tn = function(truth, response, positive, ...) {
  assert_binary(truth, response = response, positive = positive)
  tn_cm(cm(truth, response, positive))
}

tn_cm = function(m, na_value = NaN) {
  m[2L, 2L]
}

#' @include measures.R
add_measure(tn, "True Negatives", "binary", 0, Inf, FALSE)

Try the mlr3measures package in your browser

Any scripts or data that you put into this service are public.

mlr3measures documentation built on Sept. 12, 2024, 7:20 a.m.