R: Maintain a global registry of available back-end Params

R Documentation

Maintain a global registry of available back-end Params

Description

Use functions on this page to add to or query a registry of back-ends, including the default for use when no BPPARAM object is provided to functions..

Usage

register(BPPARAM, default=TRUE)
registered(bpparamClass)
bpparam(bpparamClass)

Arguments

`BPPARAM`	An instance of a `BiocParallelParam` class, e.g., `MulticoreParam`, `SnowParam`, `DoparParam`.
`default`	Make this the default `BiocParallelParam` for subsequent evaluations? If `FALSE`, the argument is placed at the lowest priority position.
`bpparamClass`	When present, the text name of the `BiocParallelParam` class (e.g., “MulticoreParam”) to be retrieved from the registry. When absent, a list of all registered instances is returned.

Details

Registering a back-end provides a configuration for parallel evaluation. Only one instance of a particular BiocParallelParam class present in the registry. Except when default=FALSE, the most recently registered BiocParallelParam instance becomes the default for subsequent parallel evaluation.

bpparam() Select the BiocParallelParam instance to use. For value bpparamClass, consult first global options, e.g., options(MulticoreParam=MulticoreParam()) and then the value of registered(bpparamClass). If bpparamClass is missing, use name <- names(registered())[1].

Value

register returns, invisibly, a list of registered back-ends.

registered returns the back-end of type bpparamClass or, if bpparamClass is missing, a list of all registered back-ends.

bpparam returns the back-end of type bpparamClass or,

Author(s)

Martin Morgan mailto:mtmorgan@fhcrc.org.

Examples

registered()
bpparam()                               # default: registered()[[1]]
bpparam("SnowParam")                    # registered SnowParam

[Package BiocParallel version 0.6.1 Index]