R/parallelize.R

In DecisionScients/NLPStudio: Natural Language Processing in Objected Oriented R Environment

#==============================================================================#
#                             parallelize                                      #
#==============================================================================#
#' parallelize
#'
#' This generic function used to parallelize a task (when possible)
#'
#' @param task - the function to parallelize
#' @param ... - other parameters required by task
#' @return r - return from task
#' @author John James
#' @export
parallelize <- function(task, ...) {

  # Calculate number of cores
  ncores <- detectCores() - 1

  # Initiate cluster
  cl <- makeCluster(ncores)
  registerDoParallel(cl)

  # Run Task
  r <- task(...)

  # Stop cluster
  stopCluster(cl)

  return(r)
}
## ---- end