BatchJobs: Batch Computing with R

Provides Map, Reduce and Filter variants to generate jobs on batch computing systems like PBS/Torque, LSF, SLURM and Sun Grid Engine. Multicore and SSH systems are also supported. For further details see the project web page.

Install the latest version of this package by entering the following in R:
AuthorBernd Bischl <>, Michel Lang <>, Henrik Bengtsson <>
Date of publication2015-03-18 18:01:21
MaintainerBernd Bischl <>
LicenseBSD_2_clause + file LICENSE

View on CRAN

Man pages

addRegistryPackages: Add packages to registry.

addRegistrySourceDirs: Add source dirs to registry.

addRegistrySourceFiles: Add source files to registry.

applyJobFunction: applyJobFunction ONLY FOR INTERNAL USAGE.

batchExpandGrid: Map function over all combinations.

batchExport: Export R object to be available on the slaves.

BatchJobs: The BatchJobs package

batchMap: Maps a function over lists or vectors, adding jobs to a...

batchMapQuick: Combination of makeRegistry, batchMap and submitJobs.

batchMapResults: Maps a function over the results of a registry by using...

batchReduce: Reduces via a binary function over a list adding jobs to a...

batchReduceResults: Reduces results via a binary function and adds jobs for this...

batchUnexport: Unload exported R objects.

callFunctionOnSSHWorkers: Call an arbitrary function on specified SSH workers.

cfBrewTemplate: Cluster functions helper: Brew your template into a job...

cfHandleUnknownSubmitError: Cluster functions helper: Handle an unknown error during job...

cfKillBatchJob: Cluster functions helper: Kill a batch job via OS command

cfReadBrewTemplate: Cluster functions helper: Read in your brew template file.

configuration: BatchJobs configuration.

copyRequiredJobFiles: ONLY FOR INTERNAL USAGE.



debugMulticore: Helper function to debug multicore mode.

debugSSH: Helper function to debug SSH mode.

filterResults: Find all results where a specific condition is true.

findJobs: Finds ids of jobs that match a query.

findState: Find jobs depending on computional state.

getConfig: Returns a list of BatchJobs configuration settings

getErrorMessages: Get error messages of jobs.

getJob: Get job from registry by id.

getJobIds: Get ids of jobs in registry.

getJobInfo: Get computational information of jobs.

getJobNr: Get number of jobs in registry.

getJobParamDf: Returns parameters for all jobs as the rows of a data.frame.

getJobResources: Function to get the resources that were submitted for some...

getJobs: Get jobs from registry by id.

getLogFiles: Get log file paths for jobs.

getResources: Function to get job resources in job function.

getSSHWorkersInfo: Print and return R installation and other information for SSH...

grepLogs: Grep log files for a pattern.

installPackagesOnSSHWorkers: Install packages on SSH workers.

killJobs: Kill some jobs on the batch system.

loadConfig: Load a specific configuration file.

loadExports: Load exported R data objects.

loadRegistry: Load a previously saved registry.

loadResult: Loads a specific result file.

loadResults: Loads result files for id vector.

makeClusterFunctions: Create a ClusterFuntions object.

makeClusterFunctionsInteractive: Create cluster functions for sequential execution in same...

makeClusterFunctionsLocal: Create cluster functions for sequential execution on local...

makeClusterFunctionsLSF: Create cluster functions for LSF systems.

makeClusterFunctionsMulticore: Use multiple cores on local Linux machine to spawn parallel...

makeClusterFunctionsSGE: Create cluster functions for Sun Grid Engine systems.

makeClusterFunctionsSLURM: Create cluster functions for SLURM-based systems.

makeClusterFunctionsSSH: Create an SSH cluster to execute jobs.

makeClusterFunctionsTorque: Create cluster functions for torque-based systems.

makeJob: Creates a job description.

makeRegistry: Construct a registry object.

makeSSHWorker: Create SSH worker for SSH cluster functions.

makeSubmitJobResult: Create a SubmitJobResult object.

reduceResults: Reduce results from result directory.

removeRegistry: Remove a registry object.

removeRegistryPackages: Remove packages from registry.

removeRegistrySourceDirs: Remove packages from registry.

removeRegistrySourceFiles: Remove source files from registry.

resetJobs: Reset computational state of jobs.

sanitizePath: Sanitize a path

setConfig: Set and overwrite configuration settings

setJobFunction: Sets the job function for already existing jobs.

setJobNames: Set job names.

showClusterStatus: Show information about available computational resources on...

showLog: Display the contents of a log file.

showStatus: Retrieve or show status information about jobs.

sourceRegistryFiles: Source registry files

submitJobs: Submit jobs or chunks of jobs to batch system via cluster...

sweepRegistry: Sweep obsolete files from the file system.

testJob: Tests a job by running it with Rscript in a new process.


waitForJobs: Wait for termination of jobs on the batch system.


addRegistryPackages Man page
addRegistrySourceDirs Man page
addRegistrySourceFiles Man page
applyJobFunction Man page
batchExpandGrid Man page
batchExport Man page
BatchJobs Man page
BatchJobs-package Man page
.BatchJobs.R Man page
batchMap Man page
batchMapQuick Man page
batchMapResults Man page
batchReduce Man page
batchReduceResults Man page
batchUnexport Man page
callFunctionOnSSHWorkers Man page
cfBrewTemplate Man page
cfHandleUnknownSubmitError Man page
cfKillBatchJob Man page
cfReadBrewTemplate Man page
ClusterFunctions Man page
configuration Man page
copyRequiredJobFiles Man page
dbCreateJobDefTable Man page
dbGetJobs Man page
debugMulticore Man page
debugSSH Man page
filterResults Man page
findDisappeared Man page
findDone Man page
findErrors Man page
findExpired Man page
findJobs Man page
findMissingResults Man page
findNotDone Man page
findNotErrors Man page
findNotOnSystem Man page
findNotRunning Man page
findNotStarted Man page
findNotSubmitted Man page
findNotTerminated Man page
findOnSystem Man page
findRunning Man page
findStarted Man page
findSubmitted Man page
findTerminated Man page
getConfig Man page
getErrorMessages Man page
getJob Man page
getJobIds Man page
getJobInfo Man page
getJobNr Man page
getJobParamDf Man page
getJobResources Man page
getJobs Man page
getLogFiles Man page
getResources Man page
getSSHWorkersInfo Man page
getStatus Man page
grepLogs Man page
installPackagesOnSSHWorkers Man page
Job Man page
killJobs Man page
loadConfig Man page
loadExports Man page
loadRegistry Man page
loadResult Man page
loadResults Man page
makeClusterFunctions Man page
makeClusterFunctionsInteractive Man page
makeClusterFunctionsLocal Man page
makeClusterFunctionsLSF Man page
makeClusterFunctionsMulticore Man page
makeClusterFunctionsSGE Man page
makeClusterFunctionsSLURM Man page
makeClusterFunctionsSSH Man page
makeClusterFunctionsTorque Man page
makeJob Man page
makeRegistry Man page
makeSSHWorker Man page
makeSubmitJobResult Man page
reduceResults Man page
reduceResultsDataFrame Man page
reduceResultsList Man page
reduceResultsMatrix Man page
reduceResultsVector Man page
Registry Man page
removeRegistry Man page
removeRegistryPackages Man page
removeRegistrySourceDirs Man page
removeRegistrySourceFiles Man page
resetJobs Man page
sanitizePath Man page
setConfig Man page
setJobFunction Man page
setJobNames Man page
showClusterStatus Man page
showLog Man page
showStatus Man page
sourceRegistryFiles Man page
SSHWorker Man page
SubmitJobResult Man page
submitJobs Man page
sweepRegistry Man page
testJob Man page
updateRegistry Man page
waitForJobs Man page


tests/testthat/test_sweepRegistry.R tests/testthat/test_export.R tests/testthat/helpers.R tests/testthat/test_reduceResults.R tests/testthat/test_getJobInfo.R tests/testthat/test_sanitizePath.R tests/testthat/test_testJob.R tests/testthat/test_filterResults.R tests/testthat/test_getJobParamDf.R tests/testthat/test_batchMapQuick.R tests/testthat/test_loadResults.R tests/testthat/test_submitJobs.R tests/testthat/test_resources.R tests/testthat/test_resetJobs.R tests/testthat/test_getLogFiles.R tests/testthat/test_waitForJobs.R tests/testthat/test_batchMap.R tests/testthat/test_setJobFunction.R tests/testthat/test_findJobs.R tests/testthat/test_showStatus.R tests/testthat/test_batchReduce.R tests/testthat/test_findStatus.R tests/testthat/test_batchMapResults.R tests/testthat/test_batchReduceResults.R tests/testthat/test_sourceRegistryFiles.R tests/testthat/test_zzz_cleanup.R tests/testthat/test_getJob.R tests/testthat/test_database.R tests/testthat/test_sqlquotes.R tests/testthat/test_batchExpandGrid.R tests/testthat/test_packages.R tests/testthat/test_makeRegistry.R tests/testthat/test_grepLogs.R tests/testthat/test_doJob.R
R/getJobInfo.R R/buffer.R R/clusterFunctionsInteractive.R R/clusterFunctions.R R/Registry.R R/filterResults.R R/reduceResults.R R/killJobs.R R/database.R R/writeRscripts.R R/callFunctionOnSSHWorkers.R R/getJobParamDf.R R/helpers.R R/Worker.R R/Job.R R/conf.R R/debugMulticore.R R/clusterFunctionsHelpers.R R/showLog.R R/debugSSH.R R/batchApply.R R/batchExpandGrid.R R/filenames.R R/Packages.R R/getErrorMessages.R R/loadResults.R R/setJobNames.R R/sanitizePath.R R/findStatus.R R/submitJobs.R R/batchReduceResults.R R/clusterFunctionsMulticore.R R/Exports.R R/syncRegistry.R R/getLogFiles.R R/sourceRegistryFiles.R R/showStatus.R R/sendMail.R R/clusterFunctionsSLURM.R R/installPackagesOnSSHWorkers.R R/getJob.R R/clusterFunctionsSGE.R R/loadResult.R R/doJob.R R/testJob.R R/waitForJobs.R R/setJobFunction.R R/clusterFunctionsSSH.R R/checkIdValid.R R/showClusterStatus.R R/batchReduce.R R/batchMapQuick.R R/clusterFunctionsLSF.R R/Resources.R R/clusterFunctionsTorque.R R/resetJobs.R R/sweepRegistry.R R/clusterFunctionsLocal.R R/updateRegistry.R R/batchMapResults.R R/findJobs.R R/getSSHWorkersInfo.R R/grepLogs.R R/batchMap.R R/zzz.R R/WorkerLinux.R R/scheduleWorkerJobs.R R/applyJobFunction.R R/addJob.R
man/makeClusterFunctionsLSF.Rd man/loadResults.Rd man/addRegistrySourceDirs.Rd man/updateRegistry.Rd man/dbCreateJobDefTable.Rd man/getJobs.Rd man/setJobNames.Rd man/applyJobFunction.Rd man/installPackagesOnSSHWorkers.Rd man/makeClusterFunctionsMulticore.Rd man/killJobs.Rd man/makeRegistry.Rd man/getErrorMessages.Rd man/configuration.Rd man/makeJob.Rd man/makeClusterFunctionsSGE.Rd man/batchExport.Rd man/makeClusterFunctionsSLURM.Rd man/batchMapResults.Rd man/cfHandleUnknownSubmitError.Rd man/loadResult.Rd man/batchMap.Rd man/showClusterStatus.Rd man/sanitizePath.Rd man/setConfig.Rd man/waitForJobs.Rd man/addRegistrySourceFiles.Rd man/copyRequiredJobFiles.Rd man/makeSubmitJobResult.Rd man/showStatus.Rd man/batchMapQuick.Rd man/loadRegistry.Rd man/reduceResults.Rd man/batchReduceResults.Rd man/filterResults.Rd man/loadConfig.Rd man/getJobInfo.Rd man/grepLogs.Rd man/makeClusterFunctions.Rd man/submitJobs.Rd man/makeClusterFunctionsInteractive.Rd man/findState.Rd man/cfKillBatchJob.Rd man/findJobs.Rd man/testJob.Rd man/showLog.Rd man/debugSSH.Rd man/removeRegistrySourceDirs.Rd man/getJobIds.Rd man/getResources.Rd man/batchReduce.Rd man/makeClusterFunctionsTorque.Rd man/addRegistryPackages.Rd man/getLogFiles.Rd man/debugMulticore.Rd man/removeRegistryPackages.Rd man/getJobParamDf.Rd man/getJobResources.Rd man/batchUnexport.Rd man/getSSHWorkersInfo.Rd man/sweepRegistry.Rd man/batchExpandGrid.Rd man/BatchJobs.Rd man/getJobNr.Rd man/makeClusterFunctionsSSH.Rd man/getJob.Rd man/resetJobs.Rd man/cfBrewTemplate.Rd man/sourceRegistryFiles.Rd man/loadExports.Rd man/setJobFunction.Rd man/callFunctionOnSSHWorkers.Rd man/dbGetJobs.Rd man/getConfig.Rd man/makeSSHWorker.Rd man/removeRegistrySourceFiles.Rd man/cfReadBrewTemplate.Rd man/removeRegistry.Rd man/makeClusterFunctionsLocal.Rd

Questions? Problems? Suggestions? or email at

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.