derfinder (version 1.6.4)

advancedArg: List advanced arguments

Description

Find in GitHub the documentation for the advanced arguments of a given function.

Usage

advancedArg(fun, package = "derfinder", browse = interactive())

Arguments

fun

The name of a function(s) that has advanced arguments in package.

package

The name of the package where the function is stored. Only 'derfinder', 'derfinderPlot', and 'regionReport' are accepted.

browse

Whether to open the URLs in a browser.

Value

• A vector of URLs with the GitHub search queries.

Details

If you are interested on the default options used for functions that run on multiple cores, check https://github.com/lcolladotor/derfinder/blob/master/R/utils.R Note that in general, SnowParam is more memory efficient than link[BiocParallel]{MulticoreParam}. If you so desire, use your favorite cluster type by specifying BPPARAM.

Examples

## Open the advanced argument docs for loadCoverage()
if(interactive()) {
    advancedArg('loadCoverage')
} else {
    (advancedArg('loadCoverage', browse = FALSE))
}