Loads a registry from its file.dir.
loadRegistry(file.dir = getwd(), work.dir = NULL,
conf.file = findConfFile(), make.default = TRUE, update.paths = FALSE)[character(1)]
Path where all files of the registry are saved.
Default is directory “registry” in the current working directory.
The provided path will get normalized unless it is given relative to the home directory
(i.e., starting with “~”). Note that some templates do not handle relative paths well.
If you pass NA, a temporary directory will be used.
This way, you can create disposable registries for btlapply or examples.
By default, the temporary directory tempdir() will be used.
If you want to use another directory, e.g. a directory which is shared between nodes,
you can set it in your configuration file by setting the variable temp.dir.
[character(1)]
Working directory for R process for running jobs.
Defaults to the working directory currently set during Registry construction (see getwd).
loadRegistry uses the stored work.dir, but you may also explicitly overwrite it,
e.g., after switching to another system.
The provided path will get normalized unless it is given relative to the home directory (i.e., starting with “~”). Note that some templates do not handle relative paths well.
[character(1)]
Path to a configuration file which is sourced while the registry is created.
For example, you can set cluster functions or default resources in it.
The script is executed inside the environment of the registry after the defaults for all variables are set,
thus you can set and overwrite slots, e.g. default.resources = list(walltime = 3600) to set default resources.
The file lookup defaults to a heuristic which first tries to read “batchtools.conf.R” in the current working directory.
If not found, it looks for a configuration file “config.R” in the OS dependent user configuration directory
as reported by via rappdirs::user_config_dir("batchtools", expand = FALSE) (e.g., on linux this
usually resolves to “~/.config/batchtools/config.R”).
If this file is also not found, the heuristic finally tries to read the file “.batchtools.conf.R” in the
home directory (“~”).
Set to character(0) if you want to disable this heuristic.
[logical(1)]
If set to TRUE, the created registry is saved inside the package
namespace and acts as default registry. You might want to switch this
off if you work with multiple registries simultaneously.
Default is TRUE.
[logical(1)]
If set to TRUE, the file.dir and work.dir will be updated in the registry. Note that this is
likely to break computation on the system! Only do this if no jobs are currently running. Default is FALSE.
If the provided file.dir does not match the stored file.dir, loadRegistry will return a
registry in read-only mode.
[Registry].
Other Registry: clearRegistry,
getDefaultRegistry,
makeRegistry, removeRegistry,
saveRegistry, sweepRegistry,
syncRegistry