seqParallelSetup: Setup/Get a Parallel Environment In SeqArray: Data management of large-scale whole-genome sequence variant calls Description Usage Arguments Details Value Author(s) See Also Examples
Description
Setups a parallel environment in R for the current session.
Usage
1 2
seqParallelSetup(cluster=TRUE, verbose=TRUE) seqGetParallel()
Arguments
cluster NULL or FALSE: serial processing; TRUE: parallel processing with the maximum number of cores minor one; a numeric value: the number of cores to be used; a cluster object for parallel processing, created by the functions in the package parallel, like makeCluster. See details
verbose if TRUE, show information
Details
When cl is TRUE or a numeric value, forking techniques are used to create a new child process as a copy of the current R process, see ?parallel::mcfork. However, forking is not available on Windows, so multiple processes created by makeCluster are used instead. The R environment option seqarray.parallel will be set according to the value of cluster. Using seqParallelSetup(FALSE) removes the registered cluster, as does stopping the registered cluster.
Value
seqParallelSetup() has no return, and seqGetParallel() returns getOption("seqarray.parallel", FALSE).
Author(s)
Xiuwen Zheng
See Also
Examples
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
library(parallel) seqParallelSetup(2L) # the GDS file (gds.fn <- seqExampleFileName("gds")) # display (f <- seqOpen(gds.fn)) # run in parallel summary(seqMissing(f)) # close the GDS file seqClose(f) seqParallelSetup(FALSE)
SeqArray documentation built on Nov. 8, 2020, 5:08 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details Value Author(s) See Also Examples
Description
Setups a parallel environment in R for the current session.
Usage
1 2 | seqParallelSetup(cluster=TRUE, verbose=TRUE) seqGetParallel() |
Arguments
cluster |
|
verbose | if |
Details
When cl is TRUE or a numeric value, forking techniques are used to create a new child process as a copy of the current R process, see ?parallel::mcfork. However, forking is not available on Windows, so multiple processes created by makeCluster are used instead. The R environment option seqarray.parallel will be set according to the value of cluster. Using seqParallelSetup(FALSE) removes the registered cluster, as does stopping the registered cluster.
Value
seqParallelSetup() has no return, and seqGetParallel() returns getOption("seqarray.parallel", FALSE).
Author(s)
Xiuwen Zheng
See Also
Examples
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | library(parallel) seqParallelSetup(2L) # the GDS file (gds.fn <- seqExampleFileName("gds")) # display (f <- seqOpen(gds.fn)) # run in parallel summary(seqMissing(f)) # close the GDS file seqClose(f) seqParallelSetup(FALSE) |
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.