parallelCheck: Parallel availability check

View source: R/parallelCheck.R

parallelCheckR Documentation

Parallel availability check

Description

Check availability of parallel package and set parameters

Usage

parallelCheck(parallel, max.ncores = 16, ncores = NULL)

Arguments

parallel

Logical, should parallel execution be used?

ncores

number of cores used in parallel computation, self-selected number of cores is used when is.null(ncpus) (the default).

maxcores

upper bound for self-selected number of cores

Details

The function checks if package parallel is available. Then, it is checked whether the FORK nodes can be initialized

Value

A list with two elements:

  • hasparallel, a logical flag indicating if parallelization is enabled and

  • cl: parallel socket cluster object, or NULL.

Author(s)

J. Bedia, with contributions by J. Bhend and M. de Felice

See Also

Other parallel.helpers: selectPar.pplyFun()


SantanderMetGroup/transformeR documentation built on Aug. 29, 2024, 6:42 a.m.