Job: Class representing a batch job

Description Usage Arguments Fields and Methods Author(s)

Description

Package: R.batch
Class Job

Object
~~|
~~+--Job

Directly known subclasses:

public static class Job
extends Object

Class representing a batch job.

A Job belongs to a JobBatch.

Usage

1
Job(jobPath=NULL, label=NULL, verbose=FALSE)

Arguments

jobPath

The job path.

label

An optional character string specifying the label (name) of the job.

verbose

If TRUE, detailed information will be given while working on the job.

Fields and Methods

Methods:

addPersistentField -
as.character Gets a character string representation of the job.
backupLog -
equals Checks if this job equals another.
finalize Finalizes job.
getDependencies -
getDependenciesRaw -
getField -
getFigurePath -
getInputPath Gets the input path of the job.
getLabel Gets the label of the job.
getLog -
getLogPath -
getName Gets the name of the job.
getOutputPath Gets the output path of the job.
getPath Gets the path to the job.
getPersistentPath -
getResultPath -
getRoot -
getStatus Gets the status of the job.
hasFailed Checks if the job failed.
hasStoredImage Checks if a stored job image exists.
isDone Checks if the job is done.
isErroneous Checks if the job is erroneous.
isExisting Checks if the job exists.
isFinished -
isLocked Checks if a job is locked.
isNewer -
isPersistentField -
isSinked Checks if job output is sinked to file.
isStarted Checks if the job is started or not.
lastModified -
listDir -
loadStoredImage Reload a stored job image.
lock Locks the job.
moveOutputFilesTo -
removeStoredImage Removes stored job image.
resetLog Reset log by removing log file.
resetToRun -
run Runs the job.
saveImage Save an image of the job.
setField -
setFigurePath -
setLabel Sets the label of the job.
setOutputPath -
setPath -
setStatus Sets the status of the job.
setup Initiates the job.
showWarnings Displays warning generated while running this job.
sink Sinks job output.
sourceDirectoryWithPreprocessor -
sourceHotCode Sources and removes code in the hot/ and src/hot/ directories.
touch -
unlock Unlocks the job.
unsink Unsinks job output.
untouch -
wasInterrupted Checks if the job was interrupted.
wasSuccessful Checks if the job was completed successfully.
writeToLog Writes to log file.

Methods inherited from Object:
$, $<-, [[, [[<-, as.character, attach, attachLocally, clearCache, clearLookupCache, clone, detach, equals, extend, finalize, gc, getEnvironment, getFieldModifier, getFieldModifiers, getFields, getInstantiationTime, getStaticInstance, hasField, hashCode, ll, load, objectSize, print, registerFinalizer, save

Author(s)

Henrik Bengtsson (http://www.braju.com/R/)


R.batch documentation built on May 2, 2019, 4:58 p.m.