batchtools: assertRegistry – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

assertRegistry

Description

Assert that a given object is a batchtools 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.

Usage

assertRegistry(
  reg,
  class = NULL,
  writeable = FALSE,
  sync = FALSE,
  running.ok = TRUE
)

Arguments

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

Value

TRUE invisibly.

batchtools

Tools for Computation on Batch Systems

v0.9.15

LGPL-3

Authors

Michel Lang [cre, aut] (<https://orcid.org/0000-0001-9754-0393>), Bernd Bischl [aut], Dirk Surmann [ctb] (<https://orcid.org/0000-0003-0873-137X>)

Initial release