heemod (version 0.9.0)

cluster: Run

Description

These functions create or delete a cluster for heemod. When the cluster is created it is automagically used by heemod functions.

Usage

use_cluster(num_cores, cluster = NULL, close = TRUE)
status_cluster(verbose = TRUE)
close_cluster()

Arguments

num_cores

Number of core.

cluster

A custom cluster. See details.

close

Close existing cluster before defining a new one?

verbose

Print cluster info.

Value

use_cluster and close_cluster return TRUE invisibly in case of success. status_cluster returns TRUE if a cluster is defined, FALSE otherwise.

Details

The usual wokflow is to create the cluster with use_cluster, then run functions such as run_psa() that make use of the cluster. To stop using the cluster run close_cluster(). The cluster status is given by status_cluster. A custom cluster can be passed to use_cluster with the cluster argument. This custom custer needs to work with parallel::parLapply().