cfBrewTemplate

[<code><a rd-options="" href="/link/Registry?package=batchtools&version=0.9.10" data-mini-rdoc="batchtools::Registry">Registry</a></code>]
Registry. If not explicitly passed, uses the default registry (see <code><a rd-options="" href="/link/setDefaultRegistry?package=batchtools&version=0.9.10" data-mini-rdoc="batchtools::setDefaultRegistry">setDefaultRegistry</a></code>).

[<code>character(1)</code>]
String ready to be brewed. See <code><a rd-options="" href="/link/cfReadBrewTemplate?package=batchtools&version=0.9.10" data-mini-rdoc="batchtools::cfReadBrewTemplate">cfReadBrewTemplate</a></code> to read a template from the file system.

text

[<code><a rd-options="" href="/link/JobCollection?package=batchtools&version=0.9.10" data-mini-rdoc="batchtools::JobCollection">JobCollection</a>)</code>]
Will be used as environment to brew the template file in. See <code><a rd-options="" href="/link/JobCollection?package=batchtools&version=0.9.10" data-mini-rdoc="batchtools::JobCollection">JobCollection</a></code> for a list of all
available variables.

This function is only intended for use in your own cluster functions implementation.
Calls brew silently on your template, any error will lead to an exception. If debug mode is
enabled (via environment variable &#8220;DEBUGME&#8221; set to &#8220;batchtools&#8221;),
the file is stored at the same place as the corresponding
job file in the &#8220;jobs&#8221;-subdir of your files directory, otherwise as <code><a rd-options="" href="/link/tempfile?package=batchtools&version=0.9.10" data-mini-rdoc="batchtools::tempfile">tempfile</a></code> on the local system.

As a successor of the packages 'BatchJobs' and 'BatchExperiments',
this package provides a parallel implementation of the Map function for high
performance computing systems managed by schedulers 'IBM Spectrum LSF'
(<http://www-03.ibm.com/systems/spectrum-computing/products/lsf/>),
'OpenLava' (<http://www.openlava.org/>), 'Univa Grid Engine'/'Oracle Grid
Engine' (<http://www.univa.com/>), 'Slurm' (<http://slurm.schedmd.com/>),
'TORQUE/PBS'
(<http://www.adaptivecomputing.com/products/open-source/torque/>), or
'Docker Swarm' (<https://docs.docker.com/swarm/>).
A multicore and socket mode allow the parallelization on a local machines,
and multiple machines can be hooked up via SSH to create a makeshift
cluster. Moreover, the package provides an abstraction mechanism to define
large-scale computer experiments in a well-organized and reproducible way.

Michel Lang

batchtools

Tools for Computation on Batch Systems

Bernd Bischl

Dirk Surmann

cfBrewTemplate function

[<code><a rd-options='' href='Registry'>Registry</a></code>]
Registry. If not explicitly passed, uses the default registry (see <code><a rd-options='' href='setDefaultRegistry'>setDefaultRegistry</a></code>).

[<code>character(1)</code>]
String ready to be brewed. See <code><a rd-options='' href='cfReadBrewTemplate'>cfReadBrewTemplate</a></code> to read a template from the file system.

[<code><a rd-options='' href='JobCollection'>JobCollection</a>)</code>]
Will be used as environment to brew the template file in. See <code><a rd-options='' href='JobCollection'>JobCollection</a></code> for a list of all
available variables.

This function is only intended for use in your own cluster functions implementation.
Calls brew silently on your template, any error will lead to an exception. If debug mode is
enabled (via environment variable &#8220;DEBUGME&#8221; set to &#8220;batchtools&#8221;),
the file is stored at the same place as the corresponding
job file in the &#8220;jobs&#8221;-subdir of your files directory, otherwise as <code><a rd-options='' href='tempfile'>tempfile</a></code> on the local system.

cfBrewTemplate: Cluster Functions Helper to Write Job Description Files

Description

Usage

Arguments

Value

See Also