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

Description Usage Arguments Details Value Author(s) See Also

Description

Static method to setup a demo job batch directory structure.

Usage

1
2
3
4
5
6
## Static method (use this):
## JobBatch$setupDemo(demo=c("mandelbrot"), overwrite=FALSE, ...)

## Don't use the below:
## S3 method for class 'JobBatch'
setupDemo(static, demo=c("mandelbrot"), overwrite=FALSE, ...)

Arguments

demo

The demo to be setup.

overwrite

If TRUE, any preexisting directory will be removed, otherwise an exception is thrown.

...

Not used.

Details

The Mandelbrot demo was adopted from code by Martin Maechler. See files in system.file("jobs-mandelbrot/src", package="R.batch") for details.

Value

Returns (invisibly) the path to the created directory, which has the base name jobs-<demo>, e.g. demo-mandelbrot.

Author(s)

Henrik Bengtsson

See Also

For more information see JobBatch.


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