Learn R Programming

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

future (version 1.19.1)

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(multiprocess)`. 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

270,166

Version

1.19.1

License

LGPL (>= 2.1)

Issues

Pull Requests

Stars

Forks

Last Published

September 22nd, 2020

Functions in future (1.19.1)

UniprocessFuture-class

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

Get number of available cores on current machine
%conditions%

Control whether standard output should be captured or not
%globals%

Specify globals and packages for a future assignment
makeClusterMPI

Create a Message Passing Interface (MPI) cluster of R workers for parallel processing
makeClusterPSOCK

Create a PSOCK cluster of R workers for parallel processing
nullcon

Creates a connection to the system null device
pid_exists

Check whether a process PID exists or not
MultiprocessFuture-class

An multiprocess future is a future whose value will be resolved asynchronously in a parallel process
MulticoreFuture-class

An multicore future is a future whose value will be resolved asynchronously in a parallel process
sessionDetails

Outputs details on the current R session
cluster

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

Get first or all references of an R object
signalConditions

Signals Captured Conditions
FutureGlobals

A representation of a set of globals used with futures
find_rshcmd

Search for SSH clients on the current system
FutureResult

Results from resolving a future
getGlobalsAndPackages

Retrieves global variables of an expression and their associated packages
clusterExportSticky

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

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

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

Specify label for a future assignment
remote

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

Get the number of workers available
requestCore

Request a core for multicore processing
sequential

Create a sequential future whose value will be in the current R session
run.Future

Run a future
multicore

Create a multicore future whose value will be resolved asynchronously in a forked parallel process
%lazy%

Control lazy / eager evaluation for a future assignment
Future-class

A future represents a value that will be available at some point in the future
plan

Plan how to resolve a future
multiprocess

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

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

Place a sticky-globals environment immediately after the global environment
.length

Gets the length of an object without dispatching
backtrace

Back trace the expressions evaluated when an error was caught
futureOf

Get the future of a future variable
futures

Get all futures in a container
availableWorkers

Get set of available workers
supportsMulticore

Check whether multicore/forked processing is supported or not
%stdout%

Control whether standard output should be captured or not
%tweak%

Temporarily tweaks the arguments of the current strategy
resolved

Check whether a future is resolved or not
result.Future

Get the results of a resolved future
tweak

Tweak a future function by adjusting its default arguments
ClusterFuture-class

A cluster future is a future whose value will be resolved asynchronously in a parallel process
ConstantFuture-class

A future with a constant value
future

Create a future
usedCores

Get number of cores currently used
future.options

Options used for futures
%plan%

Use a specific plan for a future assignment
%seed%

Set random seed for future assignment
make_rng_seeds

Produce Reproducible Seeds for Parallel Random Number Generation
resolve

Resolve one or more futures synchronously
value

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

Mandelbrot convergence counts
resetWorkers

Free up active background workers
as.cluster

Coerce an object to a cluster object
autoStopCluster

Automatically stop a cluster when garbage collected