pbmcapply (version 1.1.0)

pbmclapply: Tracking mclapply with progress bar

Description

pbmclapply is a wrapper around the mclapply function. It adds a progress bar to mclapply function.

This function works on *nix (Linux, Unix such as macOS) system only due to the lack of fork() functionality, which is essential for mcapply, on Windows.

Usage

pbmclapply(X, FUN, ..., mc.style = 3, mc.cores =getOption("mc.cores", 2L))

Arguments

X

a vector (atomic or list) or an expressions vector. Otherobjects (including classed objects) will be coerced by 'as.list'.

FUN

the function to be applied to.

...

optional arguments to FUN.

mc.cores

see mclapply.

mc.style

style of the progress bar. See txtProgressBar.

Examples

# A lazy sqrt function which doesn't care about efficiency
lazySqrt <- function(num) {
  # Sleep randomly between 0 to 1 second
  Sys.sleep(runif(1))
  return(sqrt(num))
}
# Get the sqrt of 1-5 in parallel
if (length(grep("windows", Sys.info()["sysname"], ignore.case = TRUE))) {
  # Windows Machine does not support mc(*)apply
  result <- pbmclapply(1:5, lazySqrt, mc.cores = 1)
} else {
  # Get the sqrt of 1-5 in parallel
  result <- pbmclapply(1:5, lazySqrt)
}