当前位置: 首页>>代码示例 >>用法及示例精选 >>正文

R yardstick detection_prevalence 检测率


检测率定义为预测阳性事件(真阳性和假阳性)的数量除以预测总数。

用法

detection_prevalence(data, ...)

# S3 method for data.frame
detection_prevalence(
  data,
  truth,
  estimate,
  estimator = NULL,
  na_rm = TRUE,
  case_weights = NULL,
  event_level = yardstick_event_level(),
  ...
)

detection_prevalence_vec(
  truth,
  estimate,
  estimator = NULL,
  na_rm = TRUE,
  case_weights = NULL,
  event_level = yardstick_event_level(),
  ...
)

参数

data

包含 truth 和 estimate 参数指定的列的 data.frame，或者 table /matrix，其中真正的类结果应位于表的列中。

...

目前未使用。

truth

真实类结果的列标识符(即 factor )。这应该是一个不带引号的列名，尽管此参数是通过表达式传递的并且支持quasiquotation(您可以不带引号的列名)。对于 _vec() 函数，一个 factor 向量。

estimate

预测类结果的列标识符(也是 factor )。与 truth 一样，可以通过不同的方式指定，但主要方法是使用不带引号的变量名称。对于 _vec() 函数，一个 factor 向量。

estimator

其中之一： "binary" 、 "macro" 、 "macro_weighted" 或 "micro" 指定要完成的平均类型。 "binary" 仅与两类情况相关。其他三种是计算多类指标的通用方法。默认会根据 estimate 自动选择 "binary" 或 "macro" 。

na_rm

logical 值，指示在计算继续之前是否应剥离 NA 值。

case_weights

案例权重的可选列标识符。这应该是一个不带引号的列名称，其计算结果为 data 中的数字列。对于 _vec() 函数，一个数值向量。

event_level

单个字符串。 "first" 或"second" 指定将truth 的哪个级别视为"event"。此参数仅适用于 estimator = "binary" 。默认使用内部帮助程序，通常默认为 "first" ，但是，如果设置了已弃用的全局选项 yardstick.event_first ，则将使用该帮助程序并发出警告。

值

tibble 包含列 .metric 、 .estimator 和 .estimate 以及 1 行值。

对于分组 DataFrame ，返回的行数将与组数相同。

对于 detection_prevalence_vec() ，单个 numeric 值(或 NA )。

相关级别

在计算二元分类指标时，对于哪个因子级别应自动被视为 "event" 或 "positive" 结果，没有通用约定。在 yardstick 中，默认使用第一级。要更改此设置，请将参数 event_level 更改为 "second" 以将因子的最后一个级别视为感兴趣级别。对于涉及 one-vs-all 比较(例如宏平均)的多类扩展，此选项将被忽略，并且 "one" 级别始终是相关结果。

多级

此指标可使用宏观、微观和宏观加权平均。如果提供了超过 2 个级别的 truth 因子，则默认选择宏平均。否则，将进行标准二进制计算。有关详细信息，请参阅vignette("multiclass", "yardstick")。

也可以看看

其他类指标：accuracy() , bal_accuracy() , f_meas() , j_index() , kap() , mcc() , npv() , ppv() , precision() , recall() , sens() , spec()

作者

马克斯·库恩

例子

# Two class
data("two_class_example")
detection_prevalence(two_class_example, truth, predicted)
#> # A tibble: 1 × 3
#>   .metric              .estimator .estimate
#>   <chr>                <chr>          <dbl>
#> 1 detection_prevalence binary         0.554

# Multiclass
library(dplyr)
data(hpc_cv)

hpc_cv %>%
  filter(Resample == "Fold01") %>%
  detection_prevalence(obs, pred)
#> # A tibble: 1 × 3
#>   .metric              .estimator .estimate
#>   <chr>                <chr>          <dbl>
#> 1 detection_prevalence macro           0.25

# Groups are respected
hpc_cv %>%
  group_by(Resample) %>%
  detection_prevalence(obs, pred)
#> # A tibble: 10 × 4
#>    Resample .metric              .estimator .estimate
#>    <chr>    <chr>                <chr>          <dbl>
#>  1 Fold01   detection_prevalence macro           0.25
#>  2 Fold02   detection_prevalence macro           0.25
#>  3 Fold03   detection_prevalence macro           0.25
#>  4 Fold04   detection_prevalence macro           0.25
#>  5 Fold05   detection_prevalence macro           0.25
#>  6 Fold06   detection_prevalence macro           0.25
#>  7 Fold07   detection_prevalence macro           0.25
#>  8 Fold08   detection_prevalence macro           0.25
#>  9 Fold09   detection_prevalence macro           0.25
#> 10 Fold10   detection_prevalence macro           0.25

# Weighted macro averaging
hpc_cv %>%
  group_by(Resample) %>%
  detection_prevalence(obs, pred, estimator = "macro_weighted")
#> # A tibble: 10 × 4
#>    Resample .metric              .estimator     .estimate
#>    <chr>    <chr>                <chr>              <dbl>
#>  1 Fold01   detection_prevalence macro_weighted     0.413
#>  2 Fold02   detection_prevalence macro_weighted     0.409
#>  3 Fold03   detection_prevalence macro_weighted     0.404
#>  4 Fold04   detection_prevalence macro_weighted     0.411
#>  5 Fold05   detection_prevalence macro_weighted     0.407
#>  6 Fold06   detection_prevalence macro_weighted     0.411
#>  7 Fold07   detection_prevalence macro_weighted     0.405
#>  8 Fold08   detection_prevalence macro_weighted     0.406
#>  9 Fold09   detection_prevalence macro_weighted     0.402
#> 10 Fold10   detection_prevalence macro_weighted     0.408

# Vector version
detection_prevalence_vec(
  two_class_example$truth,
  two_class_example$predicted
)
#> [1] 0.554

# Making Class2 the "relevant" level
detection_prevalence_vec(
  two_class_example$truth,
  two_class_example$predicted,
  event_level = "second"
)
#> [1] 0.446

相关用法


注：本文由纯净天空筛选整理自Max Kuhn等大神的英文原创作品 Detection prevalence。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。