1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Registry.R
\name{assertRegistry}
\alias{assertRegistry}
\title{assertRegistry}
\usage{
assertRegistry(
reg,
class = NULL,
writeable = FALSE,
sync = FALSE,
running.ok = TRUE
)
}
\arguments{
\item{reg}{[\code{\link{Registry}}]\cr
The object asserted to be a \code{Registry}.}
\item{class}{[\code{character(1)}]\cr
If \code{NULL} (default), \code{reg} must only inherit from class \dQuote{Registry}.
Otherwise check that \code{reg} is of class \code{class}.
E.g., if set to \dQuote{Registry}, a \code{\link{ExperimentRegistry}} would not pass.}
\item{writeable}{[\code{logical(1)}]\cr
Check if the registry is writeable.}
\item{sync}{[\code{logical(1)}]\cr
Try to synchronize the registry by including pending results from the file system.
See \code{\link{syncRegistry}}.}
\item{running.ok}{[\code{logical(1)}]\cr
If \code{FALSE} throw an error if jobs associated with the registry are currently running.}
}
\value{
\code{TRUE} invisibly.
}
\description{
Assert that a given object is a \code{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.
}
|
