Learn R Programming

⚠️There's a newer version (1.69.0) of this package.Take me there.

future (version 1.24.0)

Unified Parallel and Distributed Processing in R for Everyone

Description

The purpose of this package is to provide a lightweight and unified Future API for sequential and parallel processing of R expression via futures. The simplest way to evaluate an expression in parallel is to use `x %<-% { expression }` with `plan(multisession)`. This package implements sequential, multicore, multisession, and cluster futures. With these, R expressions can be evaluated on the local machine, in parallel a set of local machines, or distributed on a mix of local and remote machines. Extensions to this package implement additional backends for processing futures via compute cluster schedulers, etc. Because of its unified API, there is no need to modify any code in order switch from sequential on the local machine to, say, distributed processing on a remote compute cluster. Another strength of this package is that global variables and functions are automatically identified and exported as needed, making it straightforward to tweak existing code to make use of futures.

Copy Link

Version

Install

install.packages('future')

Monthly Downloads

377,288

Version

1.24.0

License

LGPL (>= 2.1)

Issues

Pull Requests

Stars

Forks

Maintainer

Henrik Bengtsson

Last Published

February 19th, 2022

Functions in future (1.24.0)

ConstantFuture-class

A future with a constant value
FutureResult

Results from resolving a future
Future-class

A future represents a value that will be available at some point in the future
MultiprocessFuture-class

A multiprocess future is a future whose value will be resolved asynchronously in a parallel process
FutureGlobals

A representation of a set of globals used with futures
UniprocessFuture-class

An uniprocess future is a future whose value will be resolved synchronously in the current process
as_lecyer_cmrg_seed

Get a L'Ecuyer-CMRG seed either from an input seed or the current RNG state
MulticoreFuture-class

A multicore future is a future whose value will be resolved asynchronously in a parallel process
ClusterFuture-class

A cluster future is a future whose value will be resolved asynchronously in a parallel process
futures

Get all futures in a container
FutureCondition

A condition (message, warning, or error) that occurred while orchestrating a future
%seed%

Set random seed for future assignment
cluster

Create a cluster future whose value will be resolved asynchronously in a parallel process
backtrace

Back trace the expressions evaluated when an error was caught
%tweak%

Temporarily tweaks the arguments of the current strategy
future

Create a future
multiprocess

Create a multiprocess future whose value will be resolved asynchronously using multicore or a multisession evaluation
%conditions%

Control whether standard output should be captured or not
future.options

Options used for futures
multisession

Create a multisession future whose value will be resolved asynchronously in a parallel R session
%stdout%

Control whether standard output should be captured or not
requestCore

Request a core for multicore processing
getGlobalsAndPackages

Retrieves global variables of an expression and their associated packages
make_rng_seeds

Produce Reproducible Seeds for Parallel Random Number Generation
clusterExportSticky

Export globals to the sticky-globals environment of the cluster nodes
mandelbrot

Mandelbrot convergence counts
getExpression

Inject code for the next type of future to use for nested futures
multicore

Create a multicore future whose value will be resolved asynchronously in a forked parallel process
run.Future

Run a future
result.Future

Get the results of a resolved future
futureOf

Get the future of a future variable
plan

Plan how to resolve a future
pid_exists

Check whether a process PID exists or not
resolve

Resolve one or more futures synchronously
usedCores

Get number of cores currently used
resolved

Check whether a future is resolved or not
value

The value of a future or the values of all elements in a container
%globals%

Specify globals and packages for a future assignment
.length

Gets the length of an object without dispatching
%label%

Specify label for a future assignment
%lazy%

Control lazy / eager evaluation for a future assignment
futureSessionInfo

Get future-specific session information and validate current backend
find_references

Get the first or all references of an R object
%plan%

Use a specific plan for a future assignment
nbrOfWorkers

Get the number of workers available
nullcon

Creates a connection to the system null device
resetWorkers

Free up active background workers
readImmediateConditions

Read All 'immediateCondition' RDS Files
re-exports

Functions Moved to 'parallelly'
remote

Create a remote future whose value will be resolved asynchronously in a remote process
save_rds

Robustly Saves an Object to RDS File Atomically
sequential

Create a sequential future whose value will be in the current R session
sticky_globals

Place a sticky-globals environment immediately after the global environment
signalConditions

Signals Captured Conditions
tweak

Tweak a future function by adjusting its default arguments
sessionDetails

Outputs details on the current R session