nc: Function to check the number of available cores

nc is a helper function to check if the number of cores required to run a parallel process is less or equal to the total number of cores of the system.

nc(ncores)

Arguments

ncores	Number of cores for the parallel process.

Value

Returns an integer representing the number of cores that will be used to run a parallel process.

Details

If ncores is bigger than the system's number of cores the function will return the system's number of cores. The functions that use this helper are mop and pROC.

Examples

# Print the number of cores
print(nc(ncores=8))
#> [1] 8