assertRegistry

Assert that a given object is a <code>batchtools</code> registry.
Additionally can sync the registry, check if it is writeable, or check if jobs are running.
If any check fails, throws an error indicting the reason for the failure.

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'
(<https://www.ibm.com/products/hpc-workload-management>),
'OpenLava' (<https://www.openlava.org/>), 'Univa Grid Engine'/'Oracle Grid
Engine' (<https://www.univa.com/>), 'Slurm' (<https://slurm.schedmd.com/>),
'TORQUE/PBS'
(<https://adaptivecomputing.com/cherry-services/torque-resource-manager/>),
or 'Docker Swarm' (<https://docs.docker.com/engine/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

assertRegistry function

<dl><dt>reg</dt>
<dd>[<code>Registry</code>] 
The object asserted to be a <code>Registry</code>.</dd>
<dt>class</dt>
<dd>[<code>character(1)</code>] 
If <code>NULL</code> (default), <code>reg</code> must only inherit from class &#8220;Registry&#8221;.
Otherwise check that <code>reg</code> is of class <code>class</code>.
E.g., if set to &#8220;Registry&#8221;, a <code>ExperimentRegistry</code> would not pass.</dd>
<dt>writeable</dt>
<dd>[<code>logical(1)</code>] 
Check if the registry is writeable.</dd>
<dt>sync</dt>
<dd>[<code>logical(1)</code>] 
Try to synchronize the registry by including pending results from the file system.
See <code>syncRegistry</code>.</dd>
<dt>running.ok</dt>
<dd>[<code>logical(1)</code>] 
If <code>FALSE</code> throw an error if jobs associated with the registry are currently running.</dd></dl>

Arguments

assertRegistry — assertRegistry

<dl>

<dt>reg</dt>
<dd>[<code>Registry</code>] 
The object asserted to be a <code>Registry</code>.</dd>


<dt>class</dt>
<dd>[<code>character(1)</code>] 
If <code>NULL</code> (default), <code>reg</code> must only inherit from class &#8220;Registry&#8221;.
Otherwise check that <code>reg</code> is of class <code>class</code>.
E.g., if set to &#8220;Registry&#8221;, a <code>ExperimentRegistry</code> would not pass.</dd>


<dt>writeable</dt>
<dd>[<code>logical(1)</code>] 
Check if the registry is writeable.</dd>


<dt>sync</dt>
<dd>[<code>logical(1)</code>] 
Try to synchronize the registry by including pending results from the file system.
See <code>syncRegistry</code>.</dd>


<dt>running.ok</dt>
<dd>[<code>logical(1)</code>] 
If <code>FALSE</code> throw an error if jobs associated with the registry are currently running.</dd>

</dl>

assertRegistry: assertRegistry

Description

Usage

Value

Arguments