Pretty print methods in a BenchDesign object

Source: R/printMethod.R

Print out details about a method included in the BenchDesign. The printMethods function is just a wrapper to call printMethod on all methods in the BenchDesign.

printMethod(bd, n = NULL)

printMethods(bd)

Arguments

bd

BenchDesign object.
n

name of a method in the BenchDesign to show.

Value

Brief description is returned to console.

See also

BDMethod-class, BenchDesign-class

Examples

## create empty BenchDesign
bench <- BenchDesign()

## currently no methods
printMethods(bench)

## add method
bench <- addMethod(bench, label = "method_a", p.adjust)
bench <- addMethod(bench, label = "method_b", qvalue::qvalue)

## show a single method
printMethod(bench, "method_a")
#> method_a --------------------------------------------------- 
#> BenchDesign Method (BDMethod) ------------------------------ 
#>   method: p.adjust
#>     function (p, method = p.adjust.methods, n = length(p)... 
#>   parameters:
#>   none
#>   post:
#>     none
#>   meta:
#>     none

## show all methods
printMethods(bench)
#> method_a --------------------------------------------------- 
#> BenchDesign Method (BDMethod) ------------------------------ 
#>   method: p.adjust
#>     function (p, method = p.adjust.methods, n = length(p)... 
#>   parameters:
#>   none
#>   post:
#>     none
#>   meta:
#>     none
#> method_b --------------------------------------------------- 
#> BenchDesign Method (BDMethod) ------------------------------ 
#>   method: qvalue::qvalue
#>     function (p, fdr.level = NULL, pfdr = FALSE, lfdr.out... 
#>   parameters:
#>   none
#>   post:
#>     none
#>   meta:
#>     none