mod_error: Error Metrics for Supervised Learning

View source: R/mod_error.R

mod_errorR Documentation

Error Metrics for Supervised Learning

Description

Calculate error metrics for pair of vector, e.g. true and estimated values from a model

Usage

mod_error(
  true,
  estimated,
  estimated.prob = NULL,
  verbose = FALSE,
  type = NULL,
  rho = FALSE,
  tau = FALSE,
  na.rm = TRUE
)

Arguments

true

Vector: True values

estimated

Vector: Estimated values

estimated.prob

Vector: Estimated probabilities for Classification, if available.

verbose

Logical: If TRUE, print output to screen

type

Character: "Regression", "Classification", or "Survival". If not provided, will be set to Regression if y is numeric.

rho

Logical: If TRUE, calculate Spearman's rho.

tau

Logical: If TRUE, calculate Kendall's tau. This can be slow for long vectors

na.rm

Logical: Passed to mean and range functions.

Details

In regression, NRMSE = RMSE / range(observed)

Value

Object of class mod_error

Author(s)

E.D. Gennatas


egenn/rtemis documentation built on May 4, 2024, 7:40 p.m.