Skip to contents

Generate a suitable parallel processing future plan for your session. See ?future::plan for more details on future plans.

Usage

suitableParallelPlan(
  strategy = NULL,
  workers = NULL,
  RAM_per_worker = 8,
  proportion_max_workers = 0.75
)

Arguments

strategy

The parallel strategy to use. See ?future::plan for details. If NULL (the default), an appropriate strategy will be detected.

workers

The number of workers to use. If NULL, the arguments RAM_per_worker and proportion_max_workers will be used to calculate a suitable number of workers.

RAM_per_worker

The memory (in gigabytes) to allocate to each worker when calculating a suitable number of workers. Ignored if argument workers is not NULL.

proportion_max_workers

A value between 0 and 1. The maximum number of workers to allocate as a proportion of the total number of workers available (as detected by future::availableCores()). Ignored if argument workers is not NULL.

Examples

if (FALSE) {
suitableParallelPlan()
}