compareBenchDesigns: Compare BenchDesign objects

In areyesq89/SummarizedBenchmark: Classes and methods for performing benchmark comparisons

Description

Comparison of BenchDesign objects and BenchDesign method information stored in SummarizedBenchmark objects. Inputs can be either BenchDesign or SummarizedBenchmark objects. If SummarizedBenchmark objects are specified, the method metadata stored in the colData will be used for the comparison. If only a single SummarizedBenchmark object is specified, the colData information will be compared with the BenchDesign object in the BenchDesign slot of the object. To compare the BenchDesign slots of SummarizedBenchmark objects, the BenchDesigns should be extracted with BenchDesign(sb) and passed as inputs (see Examples).

Usage

compareBenchDesigns(x, y = NULL, ...)

## S4 method for signature 'SummarizedBenchmark,missing'
compareBenchDesigns(x, y = NULL,
  ...)

## S4 method for signature 'SummarizedBenchmark,SummarizedBenchmark'
compareBenchDesigns(x,
  y = NULL, ...)

## S4 method for signature 'SummarizedBenchmark,BenchDesign'
compareBenchDesigns(x,
  y = NULL, ...)

## S4 method for signature 'BenchDesign,SummarizedBenchmark'
compareBenchDesigns(x,
  y = NULL, ...)

## S4 method for signature 'BenchDesign,BenchDesign'
compareBenchDesigns(x, y = NULL, ...)

Arguments

x	a SummarizedBenchmark or BenchDesign object
y	an optional second SummarizedBenchmark or BenchDesign object (default = NULL)
...	other parameters

Value

list of comparison results

Author(s)

Patrick Kimes

See Also

compareBDMethod, compareBDData

Examples

bd1 <- 
    BenchDesign(norm_sd = BDMethod(stats::rnorm,
                                   params = rlang::quos(n = n),
                                   post = sd),
                t_sd = BDMethod(stats::rt,
                                params = rlang::quos(n = n, df = 1),
                                post = sd))
bd2 <- addMethod(bd1, "chi_sd",
                 func = stats::rchisq,
                 params = rlang::quos(n = n, df = 1),
                 post = sd)

compareBenchDesigns(bd1, bd2)

areyesq89/SummarizedBenchmark documentation built on Sept. 2, 2021, 4:15 p.m.