MachineShop (version 3.7.0)

metricinfo: Display Performance Metric Information

Description

Display information about metrics provided by the MachineShop package.

Usage

metricinfo(...)

Value

List of named metric elements each containing the following components:

label

character descriptor for the metric.

maximize

logical indicating whether higher values of the metric correspond to better predictive performance.

arguments

closure with the argument names and corresponding default values of the metric function.

response_types

data frame of the observed and predicted response variable types supported by the metric.

Arguments

...

metric functions or function names; observed responses; observed and predicted responses; confusion or resample results for which to display information. If none are specified, information is returned on all available metrics by default.

Examples

## All metrics
metricinfo()

## Metrics by observed and predicted response types
names(metricinfo(factor(0)))
names(metricinfo(factor(0), factor(0)))
names(metricinfo(factor(0), matrix(0)))
names(metricinfo(factor(0), numeric(0)))

## Metric-specific information
metricinfo(auc)