R: Enhancing the 'parallel' Package

# Enhancing the 'parallel' Package

## Documentation for package ‘parallelly’ version 1.48.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A C F I K M P R S Z

## -- A --

as.cluster | Coerce an Object to a Cluster Object
as.cluster.cluster | Coerce an Object to a Cluster Object
as.cluster.list | Coerce an Object to a Cluster Object
as.cluster.RichSOCKnode | Coerce an Object to a Cluster Object
as.cluster.SOCK0node | Coerce an Object to a Cluster Object
as.cluster.SOCKnode | Coerce an Object to a Cluster Object
autoStopCluster | Automatically Stop a Cluster when Garbage Collected
availableConnections | Number of Available and Free Connections
availableCores | Get Number of Available Cores on The Current Machine
availableWorkers | Get Set of Available Workers

## -- C --

c.cluster | Coerce an Object to a Cluster Object
cloneNode | Clone one or more nodes
connectionId | Checks if a Connection is Valid

## -- F --

freeConnections | Number of Available and Free Connections
freePort | Find a TCP port that can be opened
future.availableCores.custom | Options Used by the 'parallelly' Package
future.availableCores.fallback | Options Used by the 'parallelly' Package
future.availableCores.methods | Options Used by the 'parallelly' Package
future.availableCores.system | Options Used by the 'parallelly' Package
future.availableWorkers.custom | Options Used by the 'parallelly' Package
future.availableWorkers.methods | Options Used by the 'parallelly' Package
future.fork.enable | Options Used by the 'parallelly' Package
future.supportsMulticore.unstable | Options Used by the 'parallelly' Package

## -- I --

isConnectionValid | Checks if a Connection is Valid
isForkedChild | Checks whether or not we are running in a forked child process
isForkedNode | Checks whether or not a Cluster Node Runs in a Forked Process
isLocalhostNode | Checks whether or not a Cluster Node Runs on Localhost
isNodeAlive | Check whether or not the cluster nodes are alive

## -- K --

killNode | Terminate one or more cluster nodes using process signaling

## -- M --

makeClusterMPI | Create a Rich Message Passing Interface (MPI) Cluster of R Workers for Parallel Processing
makeClusterPSOCK | Create a Rich PSOCK Cluster of R Workers for Parallel Processing
makeClusterSequential | Create a "parallel" cluster running sequentially in the current session
makeNodePSOCK | Create a Rich PSOCK Cluster of R Workers for Parallel Processing

## -- P --

parallelly.availableCores.custom | Options Used by the 'parallelly' Package
parallelly.availableCores.fallback | Options Used by the 'parallelly' Package
parallelly.availableCores.fraction | Options Used by the 'parallelly' Package
parallelly.availableCores.logical | Options Used by the 'parallelly' Package
parallelly.availableCores.max | Options Used by the 'parallelly' Package
parallelly.availableCores.methods | Options Used by the 'parallelly' Package
parallelly.availableCores.methods.excludes | Options Used by the 'parallelly' Package
parallelly.availableCores.min | Options Used by the 'parallelly' Package
parallelly.availableCores.omit | Options Used by the 'parallelly' Package
parallelly.availableCores.system | Options Used by the 'parallelly' Package
parallelly.availableWorkers.custom | Options Used by the 'parallelly' Package
parallelly.availableWorkers.methods | Options Used by the 'parallelly' Package
parallelly.availableWorkers.methods.excludes | Options Used by the 'parallelly' Package
parallelly.debug | Options Used by the 'parallelly' Package
parallelly.fork.enable | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.calls | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.connectTimeout | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.rscript_call | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.rshcmd | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.rshopts | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.setup_strategy | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.socketOptions | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.timeout | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.tries | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.tries.delay | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.useXDR | Options Used by the 'parallelly' Package
parallelly.makeNodePSOCK.validate | Options Used by the 'parallelly' Package
parallelly.maxWorkers.localhost | Options Used by the 'parallelly' Package
parallelly.maxWorkers.localhost.ignore | Options Used by the 'parallelly' Package
parallelly.options | Options Used by the 'parallelly' Package
parallelly.supportsMulticore.disableOn | Options Used by the 'parallelly' Package
parallelly.supportsMulticore.unstable | Options Used by the 'parallelly' Package

## -- R --

RMPI | Create a Rich Message Passing Interface (MPI) Cluster of R Workers for Parallel Processing
RPSOCK | Create a Rich PSOCK Cluster of R Workers for Parallel Processing
R_FUTURE_AVAILABLECORES_FALLBACK | Options Used by the 'parallelly' Package
R_FUTURE_AVAILABLECORES_SYSTEM | Options Used by the 'parallelly' Package
R_FUTURE_FORK_ENABLE | Options Used by the 'parallelly' Package
R_FUTURE_SUPPORTSMULTICORE_UNSTABLE | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_FALLBACK | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_FRACTION | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_LOGICAL | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_MAX | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_METHODS | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_METHODS_EXCLUDES | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_MIN | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_OMIT | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLECORES_SYSTEM | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLEWORKERS_METHODS | Options Used by the 'parallelly' Package
R_PARALLELLY_AVAILABLEWORKERS_METHODS_EXCLUDES | Options Used by the 'parallelly' Package
R_PARALLELLY_FORK_ENABLE | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_CALLS | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_CONNECTTIMEOUT | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_RSCRIPT_CALL | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_RSHCMD | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_RSHOPTS | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_SETUP_STRATEGY | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_SOCKETOPTIONS | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_TIMEOUT | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_TRIES | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_TRIES_DELAY | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_USEXDR | Options Used by the 'parallelly' Package
R_PARALLELLY_MAKENODEPSOCK_VALIDATE | Options Used by the 'parallelly' Package
R_PARALLELLY_MAXWORKERS_LOCALHOST | Options Used by the 'parallelly' Package
R_PARALLELLY_MAXWORKERS_LOCALHOST_IGNORE | Options Used by the 'parallelly' Package
R_PARALLELLY_SUPPORTSMULTICORE_DISABLEON | Options Used by the 'parallelly' Package
R_PARALLELLY_SUPPORTSMULTICORE_UNSTABLE | Options Used by the 'parallelly' Package

## -- S --

SEQ | Create a "parallel" cluster running sequentially in the current session
serializedSize | Calculate the size of an R object when it is serialized
supportsMulticore | Check If Forked Processing ("multicore") is Supported

## -- Z --

zzz-parallelly.options | Options Used by the 'parallelly' Package