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

Setups a parallel environment in R for the current session.

1 2	seqParallelSetup(cluster=TRUE, verbose=TRUE) seqGetParallel()

`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

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.

seqParallelSetup() has no return, and seqGetParallel() returns getOption("seqarray.parallel", FALSE).

Xiuwen Zheng

seqParallel, seqApply

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)