The development of BatchJobs and BatchExperiments is discontinued because of the following reasons:

  • Maintainability: The packages BatchJobs and BatchExperiments are tightly connected which makes maintaining difficult. Changes have to be synchronized and tested against the current CRAN versions for compatibility. Furthermore, BatchExperiments violates CRAN policies by calling internal functions of BatchJobs.
  • Data base issues: Although we invested weeks to mitigate issues with locks of the SQLite data base or file system (staged queries, file system timeouts, …), BatchJobs kept working unreliable on some systems with high latency or specific file systems. This made BatchJobs unusable for many users.

BatchJobs and BatchExperiments will remain on CRAN, but new features are unlikely to be ported back.

Comparison with BatchJobs/BatchExperiments

Internal changes

  • batchtools does not use SQLite anymore. Instead, all the information is stored directly in the registry using data.tables acting as an in-memory database. As a side effect, many operations are much faster.
  • Nodes do not have to access the registry. submitJobs() stores a temporary object of type JobCollection on the file system which holds all the information necessary to execute a chunk of jobs via doJobCollection() on the node. This avoids file system locks because each job accesses only one file exclusively.
  • ClusterFunctionsMulticore now uses the parallel package for multicore execution. ClusterFunctionsSSH can still be used to emulate a scheduler-like system which respects the work load on the local machine.

Interface changes

  • batchtools remembers the last created or loaded Registry and sets it as default registry. This way, you do not need to pass the registry around anymore. If you need to work with multiple registries simultaneously on the other hand, you can still do so by explicitly passing registries to the functions.
  • Most functions now return a data.table which is keyed with the This way, return values can be joined together easily and efficient (see this help page for some examples).
  • The building blocks of a problem has been renamed from static and dynamic to the more intuitive data and fun. Thus, algorithm function should have the formal arguments job, data and instance.
  • The function makeDesign has been removed. Parameters can be defined by just passing a data.frame or data.table to addExperiments. For exhaustive designs, use expand.grid() or data.table::CJ().

Template changes

  • The scheduler should directly execute the command Rscript -e 'batchtools::doJobCollection(<filename>)'. There is no intermediate R source file like in BatchJobs.
  • All information stored in the object JobCollection can be accessed while brewing the template.
  • Some variable names have changed and need to be adapted, e.g. is now job.hash.
  • Extra variables may be passed via the argument resoures of submitJobs.

New features

  • Support for Docker Swarm via ClusterFunctionsDocker.
  • Jobs can now be tagged and untagged to provide an easy way to group them.
  • Some resources like the number of CPUs are now optionally passed to parallelMap. This eases nested parallelization, e.g. to use multicore parallelization on the slave by just setting a resource on the master. See submitJobs() for an example.
  • ClusterFunctions are now more flexible in general as they can define hook functions which will be called at certain events. ClusterFunctionsDocker is an example use case which implements a housekeeping routine. This routine is called every time before a job is about to get submitted to the scheduler (in the case: the Docker Swarm) via the hook pre.submit and every time directly after the registry synchronized jobs stored on the file system via the hook post.sync.
  • More new features are covered in the NEWS.

Porting to batchtools

The following table assists in porting to batchtools by mapping BatchJobs/BatchExperiments functions to their counterparts in batchtools. The table does not cover functions which are (a) used only internally in BatchJobs and (b) functions which have not been renamed.

BatchJobs batchtools
addRegistryPackages Set reg$packages or reg$namespaces, call saveRegistry
addRegistrySourceDirs -
addRegistrySourceFiles Set reg$source, call saveRegistry
batchExpandGrid batchMap: batchMap(..., args = CJ(x = 1:3, y = 1:10))
batchMapQuick btmapply
batchReduceResults -
batchUnexport batchExport
filterResults -
getJobIds findJobs
getJobInfo getJobStatus
getJob makeJob
getJobParamDf getJobPars
loadResults reduceResultsList
reduceResultsDataFrame reduceResultsDataTable
reduceResultsMatrix reduceResultsList +, res)
reduceResultsVector reduceResultsDataTable
setJobFunction -
setJobNames -
showStatus getStatus