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).
compareBenchDesigns(x, y = NULL, ...) # S4 method for SummarizedBenchmark,missing compareBenchDesigns(x, y = NULL, ...) # S4 method for SummarizedBenchmark,SummarizedBenchmark compareBenchDesigns(x, y = NULL, ...) # S4 method for SummarizedBenchmark,BenchDesign compareBenchDesigns(x, y = NULL, ...) # S4 method for BenchDesign,SummarizedBenchmark compareBenchDesigns(x, y = NULL, ...) # S4 method for BenchDesign,BenchDesign compareBenchDesigns(x, y = NULL, ...)
| x | a SummarizedBenchmark or BenchDesign object |
|---|---|
| y | an optional second SummarizedBenchmark or BenchDesign object (default = NULL) |
| ... | other parameters |
list of comparison results
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)#> $methods #> $methods$res #> # A tibble: 3 x 7 #> overlap label f meta params post version #> <chr> <chr> <lgl> <lgl> <lgl> <lgl> <lgl> #> 1 Both norm_sd TRUE TRUE TRUE TRUE TRUE #> 2 Both t_sd TRUE TRUE TRUE TRUE TRUE #> 3 yOnly chi_sd NA NA NA NA NA #> #> $methods[[2]] #> # A tibble: 2 x 8 #> label func.pkg func.pkg.vers func.pkg.manual param.n param.df f post #> <chr> <chr> <chr> <lgl> <chr> <chr> <lis> <list> #> 1 norm_sd stats 3.6.0 FALSE n NA <fn> <list [… #> 2 t_sd stats 3.6.0 FALSE n 1 <fn> <list [… #> #> $methods[[3]] #> # A tibble: 3 x 8 #> label func.pkg func.pkg.vers func.pkg.manual param.n param.df f post #> <chr> <chr> <chr> <lgl> <chr> <chr> <lis> <list> #> 1 norm_sd stats 3.6.0 FALSE n NA <fn> <list [… #> 2 t_sd stats 3.6.0 FALSE n 1 <fn> <list [… #> 3 chi_sd stats 3.6.0 FALSE n 1 <fn> <list [… #> #> #> $data #> $data$data #> NULL #> #> $data$type #> [1] TRUE #> #>