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

In HenrikBengtsson/R.batch: Methods to run batch jobs in R

Description

Static method to be called from the command line. When called, this method will process one available job and return.

The following R command line options are recognized:

• --root=<path> or --root <path> specifies the root path of the batch directory.

• --reset specifies if each job should be reset before it is started.

• --sink specifies if each job output should be sinked to file.

• --details specifies if extra information should be printed to the standard output.

• --maxJobs specifies the maximum number of jobs this batch dispatcher should process before quiting. If -1, it runs until no more jobs are found. If Inf, it runs forever until being interrupted.

• --sleepTime specifies the number of seconds for R to sleep before checking for new jobs, when no more jobs are available. Only effective if --maxJobs=Inf.

• --clean specifies if all job specific created in the output path should be moved to the job path when job is done.

To avoid warning about unknown options when R, add these options at end after --args. See example below.

To run this from the command line, see 1. Useful scripts.

Usage

## Static method (use this):
## JobBatch$main(root="jobs", reset=FALSE, sink=TRUE, details=FALSE, maxJobs=1,
##   sleepTime=15, clean=FALSE, ...)

## Don't use the below:
## S3 method for class 'JobBatch'
main(static, root="jobs", reset=FALSE, sink=TRUE, details=FALSE, maxJobs=1, sleepTime=15,
  clean=FALSE, ...)

Arguments

root	A character string specifying the default value for the command line option --root.
reset	A logical value specifying the default value for the command line option --reset.
sink	A logical value specifying the default value for the command line option --sink.
details	A logical value specifying the default value for the command line option --details.
maxJobs	A integer (or the double Inf) value specifying the default value for the command line option --maxJobs.
sleepTime	A double value specifying the default value for the command line option --sleepTime.
clean	If TRUE, job specific files in the output path are moved to the job path after job is finished.
...	Not used.

Value

Returns (invisibly) the Job object processed, otherwise NULL.

Author(s)

Henrik Bengtsson

See Also

For more information see JobBatch.

Examples

## Not run: 
  RJobBatch --details --root=jobs-mandelbrot

## End(Not run)

HenrikBengtsson/R.batch documentation built on May 6, 2019, 11:52 p.m.