List pre-defined metrics for SummarizedBenchmark objects

This function returns a data frame summarizing the default performance metrics provided in this package. The data.frame contains three columns, functions is the name of the performance metric, description is longer description of the performance metric and requiredTruth is logical depending on whether the performance metrics require ground truths.

availableMetrics()

Value

A data.frame summarizing the default performance metrics provided in this package.

Examples

availableMetrics()
#>            functions                                   description
#> 1         rejections                          Number of rejections
#> 2                TPR                            True Positive Rate
#> 3                TNR                            True Negative Rate
#> 4                FDR              False Discovery Rate (estimated)
#> 5                FNR                           False Negative Rate
#> 6        correlation                           Pearson correlation
#> 7               sdad Standard Deviation of the Absolute Difference
#> 8            hamming                              Hamming distance
#> 9             LPnorm                                    L_{p} norm
#> 10 adjustedRandIndex                           Adjusted Rand Index
#>    requiresTruth
#> 1          FALSE
#> 2           TRUE
#> 3           TRUE
#> 4           TRUE
#> 5           TRUE
#> 6           TRUE
#> 7           TRUE
#> 8           TRUE
#> 9           TRUE
#> 10          TRUE