當前位置: 首頁>>代碼示例 >>用法及示例精選 >>正文

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。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。