View source: R/BatchtoolsFuture-class.R
BatchtoolsCustomFuture | R Documentation |
A batchtools future is a future whose value will be resolved via batchtools
BatchtoolsCustomFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsBashFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsFuture(
expr = NULL,
envir = parent.frame(),
substitute = TRUE,
globals = TRUE,
packages = NULL,
label = NULL,
resources = list(),
workers = NULL,
finalize = getOption("future.finalize", TRUE),
conf.file = findConfFile(),
cluster.functions = NULL,
registry = list(),
...
)
BatchtoolsMultiprocessFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsMulticoreFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsTemplateFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsLsfFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsOpenLavaFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsSGEFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsSlurmFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsTorqueFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsSSHFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
workers = availableCores(),
...
)
BatchtoolsUniprocessFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsLocalFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsInteractiveFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
expr |
The R expression to be evaluated |
substitute |
Controls whether |
envir |
The environment in which global environment should be located. |
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). |
resources |
(optional) A named list passed to the batchtools
template (available as variable |
workers |
(optional) The maximum number of workers the batchtools
backend may use at any time. Interactive and "local" backends can only
process one future at the time ( |
finalize |
If TRUE, any underlying registries are deleted when this object is garbage collected, otherwise not. |
conf.file |
(optional) A batchtools configuration file. |
cluster.functions |
(optional) A batchtools ClusterFunctions object. |
registry |
(optional) A named list of settings to control the setup of the batchtools registry. |
... |
Additional arguments passed to |
A BatchtoolsFuture object
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.