R/datasets.R

#' mlr benchmark input
#'
#' Contains the wrapped mlr benchmark result (\code{mlr.benchmark.example}).
#' It is a basic Version of a useable mlr benchmark result data table.
#' It was converted to a data table useable within the benchmarkVis application through the mlrBenchmarkWrapper.
#' The file is accessible through "mlr.benchmark.example".
#' @name mlr.benchmark.example
#' @docType data
#' @references See \url{data/mlr.benchmark.example.RData}
#' @keywords data
NULL

#' mlr tuning input
#'
#' Contains the wrapped mlr tuning result (\code{mlr.tuning.example}).
#' It is a basic Version of a useable mlr tuning result data table.
#' It was converted to a data table useable within the benchmarkVis application through the mlrTuningWrapper.
#' The file is accessible through "mlr.tuning.example".
#' @name mlr.tuning.example
#' @docType data
#' @references See \url{data/mlr.tuning.example.RData}
#' @keywords data
NULL

#' microbenchmark input
#'
#' Contains the wrapped microbenchmark result (\code{microbenchmark.example}).
#' It is a basic Version of a useable benchmark result data table.
#' It was converted to a data table useable within the benchmarkVis application through the microbenchmarkWrapper.
#' The file is accessible through "microbenchmark.example".
#' @name microbenchmark.example
#' @docType data
#' @references See \url{data/microbenchmark.example.RData}
#' @keywords data
NULL

#' rbenchmark input
#'
#' Contains the wrapped rbenchmark result (\code{rbenchmark.example}).
#' It is a basic Version of a useable benchmark result data table.
#' It was converted to a data table useable within the benchmarkVis application through the rbenchmarkWrapper.
#' The file is accessible through "rbenchmark.example".
#' @name rbenchmark.example
#' @docType data
#' @references See \url{data/rbenchmark.example.RData}
#' @keywords data
NULL

#' Example CSV file
#'
#' Contains the same data table as (\code{mlr.benchmark.example}).
#' This file is an example of how a useable csv file should be structured.
#' It can be loaded into the benchmarkVis application through the csvImport method.
#' @name ml.example
#' @docType data
#' @references See \url{extdata/ml.example.csv}
#' @keywords data
NULL

#' Example Json file
#'
#' Contains the same data table as (\code{mlr.benchmark.example}).
#' This file is an example of how a useable json file should be structured.
#' It can be loaded into the benchmarkVis application through the jsonImport method.
#' @name ml.example2
#' @docType data
#' @references See \url{extdata/ml.example2.json}
#' @keywords data
NULL

#' Large benchmark
#'
#' A large example of a benchmark created with mlr. It was converted to the benchmarkVis table structure by the mlrBenchmarkWrapper.
#' The table consists of 18 columns and 210 rows.
#' Problems: iris, sonar, pid, ring, wave, breast.cancer.
#' Algorithms: lda, rpart, xgboost, randomForest, naiveBayes, ksvm, knn.
#' Replications: Subsample, Holdout, CV 5, LOO, Bootstrap.
#' The file is accessible through "large.benchmark".
#' @name large.benchmark
#' @docType data
#' @references See \url{data/large.benchmark.RData}
#' @keywords data
NULL
collinleiber/benchmarkVis documentation built on May 28, 2019, 8:23 a.m.