R/parallel.R

In EvoLandEco/eve: Evolution Emulator, phylogenetically dependent

check_parallel_arguments <- function(strategy = NULL,
                                     workers = NULL,
                                     verbose = TRUE) {
  if (workers == 1 |
      identical(strategy, "sequential")) {
    if (verbose == TRUE) {
      message("Running sequential task")
    }
    strategy <- eval(parse(text = paste0("future::", strategy)))
    future::plan(strategy)
  } else if (!(workers %% 1 == 0)) {
    stop("Number of workers should be an integer")
  } else {
    if (strategy %in% c("multisession", "multicore", "cluster")) {
      message("Parallel computing with large dataset may use huge memory. More workers will create more overhead, thus the speed-up is not linear. Please consider using a cluster with more computational power and memory.")
      if (verbose == TRUE) {
        message(paste0(
          "Running ",
          strategy,
          " task with ",
          workers,
          " workers"
        ))
      }
      strategy <- eval(parse(text = paste0("future::", strategy)))
      future::plan(strategy, workers = workers)
    } else {
      stop("Incorrect parallel computing strategy")
    }
  }
}