recall: Recall

In brandon-mosqueda/SKM: Sparse Kernels Methods

Recall

Description

Given the observed and predicted values of categorical data (of any number of classes) computes the recall (also known as sensitibity), the metric that evaluates a models ability to predict true positives of each available category.

Usage

recall(observed, predicted, positive_class = NULL, remove_na = TRUE)

Arguments

observed	(factor) The observed values. It has to have the same length as predicted.
predicted	(factor) The observed values. It has to have the same length as observed.
positive_class	(character(1)) The name of the class (level) to be taken as reference as the positive class. This parameter is only used for binary variables. NULL by default which uses the second class in the union of the classes (levels) in observed and predicted.
remove_na	(logical(1)) Should NA values be removed?. TRUE by default.

Details

Given the following binary confusion matrix:

Recall is computed as:

Value

For binary data a single value is returned, for more than 2 categories a vector of recalls is returned, one per each category.

See Also

Other categorical_metrics: accuracy(), brier_score(), categorical_summary(), confusion_matrix(), f1_score(), kappa_coeff(), math_mode(), matthews_coeff(), pccc(), pcic(), pr_auc(), precision(), roc_auc(), sensitivity(), specificity()

Examples

## Not run: 
recall(factor(c("a", "b")), factor(c("a", "b")))
recall(factor(c("a", "b")), factor(c("b", "a")))
recall(factor(c("a", "b")), factor(c("b", "b")))
recall(factor(c(TRUE, FALSE)), factor(c(FALSE, TRUE)))
recall(factor(c("a", "b", "a")), factor(c("b", "a", "c")))

## End(Not run)

brandon-mosqueda/SKM documentation built on Feb. 8, 2025, 5:24 p.m.