View source: R/class-detection_rate.R
| detection_rate | R Documentation |
Detection rate is the proportion of all observations that are true positives.
detection_rate(data, ...)
## S3 method for class 'data.frame'
detection_rate(
data,
truth,
estimate,
estimator = NULL,
na_rm = TRUE,
case_weights = NULL,
event_level = yardstick_event_level(),
...
)
detection_rate_vec(
truth,
estimate,
estimator = NULL,
na_rm = TRUE,
case_weights = NULL,
event_level = yardstick_event_level(),
...
)
data |
Either a |
... |
Not currently used. |
truth |
The column identifier for the true class results
(that is a |
estimate |
The column identifier for the predicted class
results (that is also |
estimator |
One of: |
na_rm |
A |
case_weights |
The optional column identifier for case weights.
This should be an unquoted column name that evaluates to a numeric column
in |
event_level |
A single string. Either |
Suppose a 2x2 table with notation:
| Reference | ||
| Predicted | Positive | Negative |
| Positive | A | B |
| Negative | C | D |
The formula used here is:
\text{Detection Rate} = \frac{A}{A + B + C + D}
Detection rate is a metric that should be maximized. The output ranges from 0 to 1. For binary data, its maximum is the prevalence of the positive class.
A tibble with columns .metric, .estimator,
and .estimate and 1 row of values.
For grouped data frames, the number of rows returned will be the same as the number of groups.
For detection_rate_vec(), a single numeric value (or NA).
There is no common convention on which factor level should
automatically be considered the "event" or "positive" result
when computing binary classification metrics. In yardstick, the default
is to use the first level. To alter this, change the argument
event_level to "second" to consider the last level of the factor the
level of interest. For multiclass extensions involving one-vs-all
comparisons (such as macro averaging), this option is ignored and
the "one" level is always the relevant result.
Macro, micro, and macro-weighted averaging is available for this metric.
The default is to select macro averaging if a truth factor with more
than 2 levels is provided. Otherwise, a standard binary calculation is done.
See vignette("multiclass", "yardstick") for more information.
Macro and micro averaging equal accuracy divided by the number of class levels. Macro-weighted averaging weights per-class detection rates by observed class frequencies. Because each per-class rate is divided by the total number of observations, the maximum of the macro and micro estimates is 1 divided by the number of class levels. Case weights apply to both rates and frequencies.
All class metrics, detection_prevalence()
Other class metrics:
accuracy(),
bal_accuracy(),
detection_prevalence(),
f_meas(),
fall_out(),
j_index(),
kap(),
markedness(),
mcc(),
miss_rate(),
npv(),
ppv(),
precision(),
recall(),
roc_dist(),
sedi(),
sens(),
spec()
# Two class
data("two_class_example")
detection_rate(two_class_example, truth, predicted)
# Multiclass
library(dplyr)
data(hpc_cv)
hpc_cv |>
filter(Resample == "Fold01") |>
detection_rate(obs, pred)
# Groups are respected
hpc_cv |>
group_by(Resample) |>
detection_rate(obs, pred)
# Weighted macro averaging
hpc_cv |>
group_by(Resample) |>
detection_rate(obs, pred, estimator = "macro_weighted")
# Vector version
detection_rate_vec(
two_class_example$truth,
two_class_example$predicted
)
# Making Class2 the "relevant" level
detection_rate_vec(
two_class_example$truth,
two_class_example$predicted,
event_level = "second"
)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.