future.batchtools.options

future.cache.path

future.batchtools.expiration.tail

future.batchtools.output

future.batchtools.workers

R_FUTURE_BATCHTOOLS_WORKERS

R_FUTURE_FUTURE_CACHE_PATH

Below are the R options and environment variables that are used by the
future.batchtools package.
See <a rd-options="future:future.options" href="/link/future%3A%3Afuture.options?package=future.batchtools&version=0.9.0&to=future%3Afuture.options" data-mini-rdoc="future:future.options::future::future.options">future::future.options</a> for additional ones that apply to futures
in general.WARNING: Note that the names and the default values of these options may change in future versions of the package. Please use with care until further notice.

internal

Implementation of the Future API on top of the 'batchtools' package.
This allows you to process futures, as defined by the 'future' package,
in parallel out of the box, not only on your local machine or ad-hoc
cluster of machines, but also via high-performance compute ('HPC') job
schedulers such as 'LSF', 'OpenLava', 'Slurm', 'SGE', and 'TORQUE' / 'PBS',
e.g. 'y <- future.apply::future_lapply(files, FUN = process)'.

Henrik Bengtsson

future.batchtools

A Future API for Parallel and Distributed Processing using
'batchtools'

future.batchtools.options function

<dl class="dl-horizontal">
<dt>future.batchtools.workers:</dt><dd>(a positive numeric or <code>+Inf</code>)
The default number of workers available on HPC schedulers with
job queues. If not set, the value of the
<code class="env">R_FUTURE_BATCHTOOLS_WORKERS</code> environment variable is used.
(Default: <code>100</code>)</dd></dl><dt>future.batchtools.output:</dt><dd>(logical)
If TRUE, batchtools will produce extra output.
If FALSE, such output will be disabled by setting batchtools
options batchtools.verbose and batchtools.progress
to FALSE.
(Default: <code>getOption("future.debug", FALSE)</code>)</dd><dt>future.batchtools.expiration.tail:</dt><dd>(a positive numeric)
When a batchtools job expires, the last few lines will be
relayed by batchtools futures to help troubleshooting.
This option controls how many lines are displayed.
(Default: <code>48L</code>)</dd><dt>future.cache.path / <code class="env">R_FUTURE_CACHE_PATH</code></dt><dd>(character string)
An absolute or relative path specifying the root folder in which
batchtools registry folders are stored.
(Default: <code>.future</code>)</dd>

Settings for batchtools futures

Options used for batchtools futures — future.batchtools.options

Options used for batchtools futures

future.batchtools.options: Options used for batchtools futures

Description

Arguments

Settings for batchtools futures