Skip to contents

Create a rbmi ready cluster

Source: R/rbmi.R
make_rbmi_cluster.Rd

This function is a wrapper around parallel::makePSOCKcluster() but takes care of configuring rbmi to be used in the sub-processes as well as loading user defined objects and libraries and setting the seed for reproducibility.

Usage

make_rbmi_cluster(cluster_or_cores = 1, objects = NULL, packages = NULL)

Arguments

cluster_or_cores

(integer or cluster object)
Number of parallel processes to use or an existing cluster to make use of

objects

(list)
A named list of objects to export into the sub-processes

packages

(character vector)
A character vector of libraries to load in the sub-processes

Value

  • If cluster_or_cores is 1, this function will return NULL.

  • If cluster_or_cores is a number greater than 1, a cluster with cluster_or_cores cores is returned.

  • If cluster_or_cores is a cluster created via parallel::makeCluster(), then this function returns it after inserting the relevant rbmi objects into the existing cluster.

Examples

if (FALSE) { # \dontrun{
make_rbmi_cluster(5)
closeAllConnections()

VALUE <- 5
myfun <- function(x) {
  x + day(VALUE)
}
make_rbmi_cluster(5, list(VALUE = VALUE, myfun = myfun), c("lubridate"))
closeAllConnections()

cl <- parallel::makeCluster(5)
make_rbmi_cluster(cl)
closeAllConnections()
} # }