MiraiFuture: A Mirai-based future task queue implementation

View source: R/MiraiFuture-class.R

MiraiFutureR Documentation

A Mirai-based future task queue implementation

Description

Set up the future parameters.

Usage

MiraiFuture(
  expr = NULL,
  substitute = TRUE,
  envir = parent.frame(),
  globals = TRUE,
  packages = NULL,
  lazy = FALSE,
  workers = availableCores(),
  dispatcher = "auto",
  ...
)

Arguments

expr

An R expression.

substitute

If TRUE, argument expr is substitute():ed, otherwise not.

envir

The environment from where global objects should be identified.

globals

(optional) a logical, a character vector, or a named list to control how globals are handled. For details, see section 'Globals used by future expressions' in the help for future().

packages

(optional) a character vector specifying packages to be attached in the R environment evaluating the future.

lazy

If FALSE (default), the future is resolved eagerly (starting immediately), otherwise not.

...

Additional named elements of the future.

Value

An object of class MiraiFuture.


future.mirai documentation built on July 3, 2024, 5:06 p.m.