R.batch: Methods to run batch jobs in R

The package provides methods to batch run R scripts in a straightforward manner. A job batch is defined by a root directory containing subdirectories todo/, running/, finished/, failed/, src/ among others. A job to be processed is a directory placed in todo/. A job is processed by moving it to running/, then sourcing the R files in src/ (containing common code) and then the ones in the job directory (contain job specific code), in which a function onRun() has to be defined, which is then called. Succesfully jobs end up in finished/ whereas failed jobs in failed/.

AuthorHenrik Bengtsson <henrikb@braju.com>
Date of publicationNone
MaintainerHenrik Bengtsson <henrikb@braju.com>
LicenseLGPL (>= 2.1)
Version0.6.1
http://www.braju.com/R/

View on R-Forge

Man pages

1._Useful_scripts: 1. Useful scripts

as.character.Job: Gets a character string representation of the job

as.character.JobBatch: Gets a character string representation of the job batch

checkRequirements.JobBatch: Checks that requirements are fulfilled or not

clean.JobBatch: Cleans up among jobs in this JobBatch

copyFrom.JobBatch: Copies a job batch directory into this one

createStub.JobBatch: Creates a jobs directory structure stub

equals.Job: Checks if this job equals another

finalize.Job: Finalizes job

findJobs.JobBatch: Searches by name for Job:s in this JobBatch

getDirectory.JobBatch: Gets a subdirectory of the job batch

getInputPath.Job: Gets the input path of the job

getLabel.Job: Gets the label of the job

getName.Job: Gets the name of the job

getNextJob.JobBatch: Gets next non-locked job

getOutputPath.Job: Gets the output path of the job

getPath.Job: Gets the path to the job

getRoot.JobBatch: Gets the root path of the job batch

getRunAndFinishJob.JobBatch: Gets an non-locked job, process it and moves it to a final...

getStatus.Job: Gets the status of the job

getSummary.JobBatch: Gets a summary of the jobs directory

hasFailed.Job: Checks if the job failed

hasStoredImage.Job: Checks if a stored job image exists

isDone.Job: Checks if the job is done

isErroneous.Job: Checks if the job is erroneous

isExisting.Job: Checks if the job exists

isLocked.Job: Checks if a job is locked

isSinked.Job: Checks if job output is sinked to file

isStarted.Job: Checks if the job is started or not

Job: Class representing a batch job

JobBatch: Class representing a batch job

loadStoredImage.Job: Reload a stored job image

lock.Job: Locks the job

main.JobBatch: Static method to be called from the command line

moveJobTo.JobBatch: Moves the job to another directory

Non-documented_objects: Non-documented objects

print.JobBatch: Prints a summary of the jobs directory

R.batch-package: Package R.batch

removeStoredImage.Job: Removes stored job image

resetJobs.JobBatch: Resets Jobs in the job batch

resetLog.Job: Reset log by removing log file

run.Job: Runs the job

run.JobBatch: Process some or all jobs available

saveImage.Job: Save an image of the job

setLabel.Job: Sets the label of the job

setStatus.Job: Sets the status of the job

setupDemo.JobBatch: Static method to setup a demo job batch directory structure

setup.Job: Initiates the job

showWarnings.Job: Displays warning generated while running this job

sink.Job: Sinks job output

sourceHotCode.Job: Sources and removes code in the hot/ and src/hot/ directories

unlock.Job: Unlocks the job

unsink.Job: Unsinks job output

validate.JobBatch: Validates the job batch

wasInterrupted.Job: Checks if the job was interrupted

wasSuccessful.Job: Checks if the job was completed successfully

writeToLog.Job: Writes to log file

Files in this package

R.batch
R.batch/R
R.batch/R/999.NonDocumentedObjects.R R.batch/R/006.fixVarArgs.R R.batch/R/901.UsefulScripts.R R.batch/R/zzz.R R.batch/R/JobBatch.R R.batch/R/000.R R.batch/R/Job.R R.batch/R/999.package.R
R.batch/NAMESPACE
R.batch/incl
R.batch/incl/JobBatch.Rex
R.batch/inst
R.batch/inst/jobs-stub
R.batch/inst/jobs-stub/failed
R.batch/inst/jobs-stub/failed/INSTRUCTIONS.txt
R.batch/inst/jobs-stub/input
R.batch/inst/jobs-stub/input/INSTRUCTIONS.txt
R.batch/inst/jobs-stub/finished
R.batch/inst/jobs-stub/finished/INSTRUCTIONS.txt
R.batch/inst/jobs-stub/erroneous
R.batch/inst/jobs-stub/erroneous/INSTRUCTIONS.txt
R.batch/inst/jobs-stub/output
R.batch/inst/jobs-stub/output/INSTRUCTIONS.txt
R.batch/inst/jobs-stub/todo
R.batch/inst/jobs-stub/todo/job02
R.batch/inst/jobs-stub/todo/job02/000.settings.R
R.batch/inst/jobs-stub/todo/job01
R.batch/inst/jobs-stub/todo/job01/000.settings.R
R.batch/inst/jobs-stub/todo/job03
R.batch/inst/jobs-stub/todo/job03/000.settings.R
R.batch/inst/jobs-stub/todo/INSTRUCTIONS.txt
R.batch/inst/jobs-stub/running
R.batch/inst/jobs-stub/running/INSTRUCTIONS.txt
R.batch/inst/jobs-stub/interrupted
R.batch/inst/jobs-stub/interrupted/INSTRUCTIONS.txt
R.batch/inst/jobs-stub/src
R.batch/inst/jobs-stub/src/000.defaultSettings.R
R.batch/inst/jobs-stub/src/onRun.R
R.batch/inst/jobs-stub/src/global
R.batch/inst/jobs-stub/src/hot
R.batch/inst/jobs-stub/src/hot/global
R.batch/inst/jobs-stub/src/000.R
R.batch/inst/jobs-stub/src/onFinally.R
R.batch/inst/jobs-stub/src/INSTRUCTIONS.txt
R.batch/inst/jobs-mandelbrot
R.batch/inst/jobs-mandelbrot/failed
R.batch/inst/jobs-mandelbrot/input
R.batch/inst/jobs-mandelbrot/finished
R.batch/inst/jobs-mandelbrot/erroneous
R.batch/inst/jobs-mandelbrot/output
R.batch/inst/jobs-mandelbrot/todo
R.batch/inst/jobs-mandelbrot/todo/job02
R.batch/inst/jobs-mandelbrot/todo/job02/000.settings.R
R.batch/inst/jobs-mandelbrot/todo/job02/hot
R.batch/inst/jobs-mandelbrot/todo/job02/hot/patch.R
R.batch/inst/jobs-mandelbrot/todo/job01
R.batch/inst/jobs-mandelbrot/todo/job01/000.settings.R
R.batch/inst/jobs-mandelbrot/todo/job01/.Dependencies
R.batch/inst/jobs-mandelbrot/todo/job05
R.batch/inst/jobs-mandelbrot/todo/job05/000.settings.R
R.batch/inst/jobs-mandelbrot/todo/job03
R.batch/inst/jobs-mandelbrot/todo/job03/000.settings.R
R.batch/inst/jobs-mandelbrot/todo/job04
R.batch/inst/jobs-mandelbrot/todo/job04/000.settings.R
R.batch/inst/jobs-mandelbrot/running
R.batch/inst/jobs-mandelbrot/interrupted
R.batch/inst/jobs-mandelbrot/src
R.batch/inst/jobs-mandelbrot/src/000.defaultSettings.R
R.batch/inst/jobs-mandelbrot/src/onStart.R
R.batch/inst/jobs-mandelbrot/src/onRun.R
R.batch/inst/jobs-mandelbrot/src/mandelbrot.R
R.batch/inst/jobs-mandelbrot/src/iterImage.R
R.batch/inst/jobs-mandelbrot/src/000.R
R.batch/inst/jobs-mandelbrot/src/onFinally.R
R.batch/inst/jobs-mandelbrot/src/.Requirements.R
R.batch/inst/bin
R.batch/inst/bin/RJobBatch
R.batch/inst/bin/RJobBatchServer.bat
R.batch/inst/bin/RJobBatchServer
R.batch/inst/bin/RJobBatch.bat
R.batch/inst/NEWS
R.batch/DESCRIPTION
R.batch/man
R.batch/man/clean.JobBatch.Rd R.batch/man/JobBatch.Rd R.batch/man/unlock.Job.Rd R.batch/man/getInputPath.Job.Rd R.batch/man/setStatus.Job.Rd R.batch/man/wasSuccessful.Job.Rd R.batch/man/writeToLog.Job.Rd R.batch/man/loadStoredImage.Job.Rd R.batch/man/as.character.JobBatch.Rd R.batch/man/getName.Job.Rd R.batch/man/1._Useful_scripts.Rd R.batch/man/validate.JobBatch.Rd R.batch/man/saveImage.Job.Rd R.batch/man/equals.Job.Rd R.batch/man/resetLog.Job.Rd R.batch/man/resetJobs.JobBatch.Rd R.batch/man/R.batch-package.Rd R.batch/man/moveJobTo.JobBatch.Rd R.batch/man/getStatus.Job.Rd R.batch/man/print.JobBatch.Rd R.batch/man/isDone.Job.Rd R.batch/man/hasStoredImage.Job.Rd R.batch/man/lock.Job.Rd R.batch/man/run.JobBatch.Rd R.batch/man/run.Job.Rd R.batch/man/isStarted.Job.Rd R.batch/man/isExisting.Job.Rd R.batch/man/setLabel.Job.Rd R.batch/man/checkRequirements.JobBatch.Rd R.batch/man/showWarnings.Job.Rd R.batch/man/getRoot.JobBatch.Rd R.batch/man/main.JobBatch.Rd R.batch/man/as.character.Job.Rd R.batch/man/sink.Job.Rd R.batch/man/isSinked.Job.Rd R.batch/man/getDirectory.JobBatch.Rd R.batch/man/isLocked.Job.Rd R.batch/man/removeStoredImage.Job.Rd R.batch/man/setup.Job.Rd R.batch/man/finalize.Job.Rd R.batch/man/isErroneous.Job.Rd R.batch/man/getRunAndFinishJob.JobBatch.Rd R.batch/man/sourceHotCode.Job.Rd R.batch/man/wasInterrupted.Job.Rd R.batch/man/createStub.JobBatch.Rd R.batch/man/setupDemo.JobBatch.Rd R.batch/man/copyFrom.JobBatch.Rd R.batch/man/getLabel.Job.Rd R.batch/man/getNextJob.JobBatch.Rd R.batch/man/getPath.Job.Rd R.batch/man/unsink.Job.Rd R.batch/man/hasFailed.Job.Rd R.batch/man/Non-documented_objects.Rd R.batch/man/Job.Rd R.batch/man/findJobs.JobBatch.Rd R.batch/man/getOutputPath.Job.Rd R.batch/man/getSummary.JobBatch.Rd

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

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