man-roxygen/binary_template.R

In mlr-org/mlr3measures: Performance Measures for 'mlr3'

#' <% item = measures[[mid]] %>
#' @description
#' Measure to compare true observed labels with predicted
#' <%= if (item$predict_type == "response") "labels" else "probabilities" %>
#' in binary classification tasks.
#'
#' <%= if (item$aggregated == FALSE) "Note that this is an unaggregated measure, returning the losses per observation." %>
#'
#' @section Meta Information:
#' * Type: `"<%= item$type %>"`
#' * Range<%= if (!item$aggregated) " (per observation)" %>: <%= format_range(item) %>
#' * Minimize<%= if (!item$aggregated) " (per observation)" %>: `<%= item$minimize %>`
#' * Required prediction: `<%= item$predict_type %>`
#'
#' @family Binary Classification Measures
#' @concept binary_classification_measure
#' @return Performance value as `numeric(<%= if (item$aggregated) "1" else "length(truth)" %>)`.