Set up or stop parallel processing plan

Configures parallel processing with future::plan() or stops an existing plan. When stopping, it resets to sequential mode.

Usage

Set_parallel(
  NCores = 1L,
  Strategy = "future::multisession",
  Stop = FALSE,
  Cat = TRUE,
  Future_maxSize = 8L,
  ...
)

Arguments

NCores

Integer. Number of cores to use. If NULL, defaults to sequential mode. Default is 1.

Strategy

Character. The parallel processing strategy to use. Valid options are future::sequential (sequential), future::multisession (default), future::multicore (not supported on Windows), and future::cluster. If Strategy is not one of the valid options or if future::multicore on Windows PC, it defaults to future::multisession. See future::plan() for more details.

Stop

Logical. If TRUE, stops any parallel cluster and resets to sequential mode. If FALSE (default), sets up a new plan.

Cat

Logical. If TRUE (default), logs messages via CatTime().

Future_maxSize

Numeric. Maximum allowed total size (in megabytes) of global variables identified. See future.globals.maxSize argument of future::future.options for more details. Default is 8.

...

Additional arguments to pass to CatTime.

Author

Ahmed El-Gabbas

Examples

# Prepare working on parallel
IASDT.R::Set_parallel(NCores = 2)
#> Setting up parallel processing with 2 core(s) - 02:38:23
future::plan()
#> multisession:
#> - args: function (..., workers = c(system = 2L), envir = parent.frame())
#> - tweaked: TRUE
#> - call: future::plan(strategy = Strategy, workers = NCores)

# ---------------------------------------------

# Stopping parallel processing
IASDT.R::Set_parallel(Stop = TRUE)
#> Stopping parallel processing - 02:38:24
future::plan()
#> sequential:
#> - args: function (..., gc = TRUE, envir = parent.frame(), workers = "<NULL>")
#> - tweaked: TRUE
#> - call: future::plan("future::sequential", gc = TRUE)

# ---------------------------------------------

# Prepare working on parallel using `future::cluster`
IASDT.R::Set_parallel(NCores = 2, Strategy = "future::cluster")
#> Setting up parallel processing with 2 core(s) - 02:38:24
future::plan()
#> cluster:
#> - args: function (..., workers = c(system = 2L), envir = parent.frame())
#> - tweaked: TRUE
#> - call: future::plan(strategy = Strategy, workers = NCores)

# Stopping parallel processing
IASDT.R::Set_parallel(Stop = TRUE)
#> Stopping parallel processing - 02:38:24
future::plan()
#> sequential:
#> - args: function (..., gc = TRUE, envir = parent.frame(), workers = "<NULL>")
#> - tweaked: TRUE
#> - call: future::plan("future::sequential", gc = TRUE)