clustermq: clustermq futures

In HenrikBengtsson/future.clustermq: A Future API for Parallel Processing using 'clustermq'

clustermq futures

Description

A clustermq future is an asynchronous multiprocess future that will be evaluated in a background R session.

Usage

clustermq(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = NULL,
  workers = getOption("future.clustermq.workers", availableCores()),
  ...
)

clustermq_local(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = NULL,
  workers = 1L,
  ...
)

clustermq_multicore(
  expr,
  envir = parent.frame(),
  substitute = TRUE,
  globals = TRUE,
  label = NULL,
  workers = availableCores(),
  ...
)

Arguments

expr	The R expression to be evaluated.
envir	The environment in which global environment should be located.
substitute	Controls whether expr should be substitute():d or not.
globals	(optional) a logical, a character vector, a named list, or a globals::Globals object. If TRUE, globals are identified by code inspection based on expr and tweak searching from environment envir. If FALSE, no globals are used. If a character vector, then globals are identified by lookup based their names globals searching from environment envir. If a named list or a Globals object, the globals are used as is.
label	(optional) Label of the future.
workers	The number of processes to be available for concurrent clustermq futures.
...	Additional arguments passed to ClusterMQFuture().

Details

clustermq futures rely on the clustermq package, which is supported on all operating systems.

Value

An object of class ClusterMQFuture.

HenrikBengtsson/future.clustermq documentation built on Nov. 18, 2022, 11:39 a.m.