View source: R/batchtools_ssh.R
batchtools_ssh | R Documentation |
A batchtools SSH future is an asynchronous multiprocess
future that will be evaluated in a background R session.
We highly recommend using future::multisession
(sic!) futures of the future package instead of
SSH batchtools futures.
batchtools_ssh(
expr,
envir = parent.frame(),
substitute = TRUE,
globals = TRUE,
label = NULL,
workers = availableWorkers(),
registry = list(),
...
)
expr |
The R expression to be evaluated |
envir |
The environment in which global environment should be located. |
substitute |
Controls whether |
globals |
(optional) a logical, a character vector, a named list, or a
Globals object. If TRUE, globals are identified by code
inspection based on |
label |
(optional) Label of the future (where applicable, becomes the job name for most job schedulers). |
workers |
The number of SSH processes to be available for concurrent batchtools SSH futures. |
registry |
(optional) A named list of settings to control the setup of the batchtools registry. |
... |
Additional arguments passed
to |
batchtools SSH futures rely on the batchtools backend set
up by batchtools::makeClusterFunctionsSSH()
.
The batchtools SSH backend only works on operating systems
supporting the ssh
and ps
command-line tool, e.g. Linux and macOS.
An object of class BatchtoolsMulticoreFuture
.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.