future v1.16.0

0

Monthly downloads

0th

Percentile

Unified Parallel and Distributed Processing in R for Everyone

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.

Functions in future

Name Description
FutureCondition A condition (message, warning, or error) that occurred while orchestrating a future
ConstantFuture-class A future with a constant value
as.cluster Coerce an object to a cluster object
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
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
ClusterFuture-class A cluster future is a future whose value will be resolved asynchronously in a parallel process
Future-class A future represents a value that will be available at some point in the future
FutureResult Results from resolving a future
availableWorkers Get set of available workers
availableCores Get number of available cores on current machine
autoStopCluster Automatically stop a cluster when garbage collected
find_references Get first or all references of an R object
find_rshcmd Search for SSH clients on the current system
future.options Options used for futures
future Create a future
cluster Create a cluster future whose value will be resolved asynchronously in a parallel process
clusterExportSticky Export globals to the sticky-globals environment of the cluster nodes
backtrace Back trace the expressions evaluated when an error was caught
%conditions% Control whether standard output should be captured or not
%lazy% Control lazy / eager evaluation for a future assignment
%globals% Specify globals and packages for a future assignment
getExpression Inject code for the next type of future to use for nested futures
%label% Specify label for a future assignment
%seed% Set random seed for future assignment
%plan% Use a specific plan for a future assignment
getGlobalsAndPackages Retrieves global variables of an expression and their associated packages
futures Get all futures in a container
futureOf Get the future of a future variable
nbrOfWorkers Get the number of workers available
make_rng_seeds Produce Reproducible Seeds for Parallel Random Number Generation
multicore Create a multicore future whose value will be resolved asynchronously in a forked parallel process
mandelbrot Mandelbrot convergence counts
multisession Create a multisession future whose value will be resolved asynchronously in a parallel R session
%tweak% Temporarily tweaks the arguments of the current strategy
%stdout% Control whether standard output should be captured or not
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
multiprocess Create a multiprocess future whose value will be resolved asynchronously using multicore or a multisession evaluation
resetWorkers Free up active background workers
nullcon Creates a connection to the system null device
pid_exists Check whether a process PID exists or not
requestCore Request a core for multicore processing
remote Create a remote future whose value will be resolved asynchronously in a remote process
.length Gets the length of an object without dispatching
plan Plan how to resolve a future
run.Future Run a future
resolved Check whether a future is resolved or not
result.Future Get the results of a resolved future
sequential Create a sequential future whose value will be in the current R session
value.Future The value of a future
resolve Resolve one or more futures synchronously
tweak Tweak a future function by adjusting its default arguments
usedCores Get number of cores currently used
sessionDetails Outputs details on the current R session
values Get all values in a container
signalConditions Signals Captured Conditions
supportsMulticore Check whether multicore/forked processing is supported or not
sticky_globals Place a sticky-globals environment immediately after the global environment
No Results!

Vignettes of future

Name
future-1-overview.md.rsp
future-2-output.md.rsp
future-3-topologies.md.rsp
future-4-issues.md.rsp
future-4-non-exportable-objects.md.rsp
future-5-startup.md.rsp
No Results!

Last month downloads

Details

VignetteBuilder R.rsp
License LGPL (>= 2.1)
LazyLoad TRUE
ByteCompile TRUE
URL https://github.com/HenrikBengtsson/future
BugReports https://github.com/HenrikBengtsson/future/issues
RoxygenNote 7.0.2
NeedsCompilation no
Packaged 2020-01-15 22:42:05 UTC; hb
Repository CRAN
Date/Publication 2020-01-16 15:20:17 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/future)](http://www.rdocumentation.org/packages/future)