showStatus: Retrieve or show status information about jobs.

View source: R/showStatus.R

showStatusR Documentation

Retrieve or show status information about jobs.

Description

E.g.: How many there are, how many are done, any errors, etc. showStatus displays on the console, getStatus returns an informative result without console output.

Usage

showStatus(reg, ids, run.and.exp = TRUE, errors = 10L)

getStatus(reg, ids, run.and.exp = TRUE)

Arguments

reg

[Registry]
Registry.

ids

[integer]
Ids of selected jobs. Default is all jobs.

run.and.exp

[logical(1)]
Show running and expired jobs? Requires to list the job on the batch system. If not possible, because that cluster function is not avilable, this option is ignored anyway. Default is TRUE.

errors

[integer(1)]
How many of the error messages should be displayed if any errors occured in the jobs? Default is 10.

Value

[list]. List of absolute job numbers. showStatus returns them invisibly.

Examples

reg = makeRegistry(id = "BatchJobsExample", file.dir = tempfile(), seed = 123)
f = function(x) x^2
batchMap(reg, f, 1:10)
submitJobs(reg)
waitForJobs(reg)

# should show 10 submitted jobs, which are all done.
showStatus(reg)

BatchJobs documentation built on March 21, 2022, 5:05 p.m.