summary.benchmark: Summary Method for 'benchmark' Class

View source: R/benchmark.R

summary.benchmarkR Documentation

Summary Method for benchmark Class

Description

Summary Method for benchmark Class

Usage

## S3 method for class 'benchmark'
summary(object, rate_tol = 0.1, loss_tol = NULL, ci_level = 0.95, ...)

Arguments

object

benchmark class output by benchmark function

rate_tol

A value in (0, 1). All repetitions with loss bigger than (1+rate_tol) * minimum_loss would be considered as a failure.

loss_tol

A real value. All repetitions with loss bigger than loss_tol would be considered as a failure.

ci_level

A value in (0, 1) for confidence level of confidence intervals in the result

...

Other arguments for summary function.

Details

If loss_tol is not NULL, rate_tol will not be used.

Value

A data frame containing useful values illustrating the performance of different algorithms.

Examples

## Not run: 
set.seed(54321)
out = benchmark("poissmix", c("raw", "squarem", "daarem", "pem", "qn", "nes"),  ntimes=100)
summary(out)

## End(Not run)


bhtang127/AccelBenchmark documentation built on May 30, 2022, 2:21 a.m.