set_parallel {methyvim} | R Documentation |
Parallelization with Futures and BiocParallel
Description
Easily set up a suitable parallelization scheme using the various options
provided in BiocParallel
and packages of the future
ecosystem.
INTERNAL USE ONLY.
Usage
set_parallel(parallel = c(TRUE, FALSE), future_param = NULL,
bppar_type = NULL)
Arguments
parallel |
Logical indicating whether parallelization ought to be used.
Parallelization is invoked via a combination of BiocParallel
and future . If TRUE the default method uses multiprocess
evaluation, though other future::plan s may be specified using
an optional argument. If FALSE , sequential computation is used
and a warning message is issued.
|
future_param |
Character (if not NULL ) specifying a particular
parallelization approach to be used. For a list of the options, see
the documentation for future::plan . If the previous argument
(parallel ) is set to FALSE , this argument is ignored and
sequential computation is invoked via future::sequential .
|
bppar_type |
Character specifying the type of backend to be used with
the parallelization invoked by BiocParallel . Consult the manual
page for BiocParallel::BiocParallelParam for possible types and
descriptions on their appropriate uses. The default for this argument
is NULL , which silently uses BiocParallel::DoparParam .
|
Value
Nothing. This function is designed to be called for its side-effect
of registering a parallel backend (for BiocParallel
) and/or
future::plan
, making parallel computation a trivial process.
[Package
methyvim version 1.5.2
Index]