xCheckParallel: Function to check whether parallel computing should be used...

In hfang-bristol/XGR: Exploring Genomic Relations for Enhanced Interpretation Through Enrichment, Similarity, Network and Annotation Analysis

Function to check whether parallel computing should be used and how

Description

xCheckParallel is used to check whether parallel computing should be used and how

Usage

xCheckParallel(multicores = NULL, verbose = TRUE)

Arguments

multicores	an integer to specify how many cores will be registered as the multicore parallel backend to the 'foreach' package. If NULL, it will use a half of cores available in a user's computer
verbose	logical to indicate whether the messages will be displayed in the screen. By default, it sets to true for display

Value

TRUE for using parallel computing; FALSE otherwise

Note

Whether parallel computation with multicores is used is system-specific. Also, it will depend on whether these two packages "foreach" and "doParallel" have been installed.

See Also

xCheckParallel

Examples

RData.location <- "http://galahad.well.ox.ac.uk/bigdata"
## Not run: 
xCheckParallel()

## End(Not run)

hfang-bristol/XGR documentation built on Feb. 4, 2023, 7:05 a.m.