summary.mpTune: summarize result from 'mpTune'

In linxihui/lazyML: Automatic machine learning algorithms and hyper-parameters selection

Description

summarize a mpTune result and print summary information

Usage

## S3 method for class 'mpTune'
summary(object, metric = object$performanceMetric,
  maximize = sapply(metric, function(x) ifelse(x %in% c("RMSE", "MAE"),
  FALSE, TRUE)), by = c("metric", "model"), ...)

## S3 method for class 'summarizedMpTune'
print(x, indent = rep(" ", 4), prefix = c("-",
  "-", "+"), digits = 3, justify = c("left", "right", "center", "none"),
  ...)

Arguments

object	A 'mpTune' object or a 'summarizedMpTune' object
metric	A vector a metric for sumary. Default to metrics used in obj
maximize	A logical vector inddicating if metric values the larger the better
by	Which should be used for the first level of the returned list. See the following for detail
...	Just for compatibility
x	A 'mpTune' object or a 'summarizedMpTune' object
indent	A string used to indent he next level of a list
prefix	A vector of characters put in front of each entry
digits	Number of effective digits to keep for double numeric value
justify	Either 'left' (default), 'right', 'center', 'none' for alignment of keys (list names)

Value

summary returns a 'summarizedMpTune' object, which is a list of two levels, either performance metrics -> models (by = 'metric') or models -> performance metrics, where models are always ranked by the performance

See Also

See mpTune for examples

linxihui/lazyML documentation built on May 21, 2019, 6:39 a.m.