Query Job Information

getJobStatus returns the internal table which stores information about the computational status of jobs, getJobPars a table with the job parameters, getJobResources a table with the resources which were set to submit the jobs, and getJobTags the tags of the jobs (see Tags).

getJobTable returns all these tables joined.

getJobTable(ids = NULL, reg = getDefaultRegistry())

getJobStatus(ids = NULL, reg = getDefaultRegistry())

getJobResources(ids = NULL, reg = getDefaultRegistry())

getJobPars(ids = NULL, reg = getDefaultRegistry())

getJobTags(ids = NULL, reg = getDefaultRegistry())

Arguments

ids	[data.frame or integer] A data.frame (or data.table) with a column named “job.id”. Alternatively, you may also pass a vector of integerish job ids. If not set, defaults to all jobs. Invalid ids are ignored.
reg	[Registry] Registry. If not explicitly passed, uses the default registry (see setDefaultRegistry).

Value

[data.table] with the following columns (not necessarily in this order):

job.id

Unique Job ID as integer.

submitted

Time the job was submitted to the batch system as POSIXct.

started

Time the job was started on the batch system as POSIXct.

done

Time the job terminated (successfully or with an error) as POSIXct.

error

Either NA if the job terminated successfully or the error message.

mem.used

Estimate of the memory usage.

batch.id

Batch ID as reported by the scheduler.

log.file

Log file. If missing, defaults to [job.hash].log.

job.hash

Unique string identifying the job or chunk.

time.queued

Time in seconds (as difftime) the job was queued.

time.running

Time in seconds (as difftime) the job was running.

pars

List of parameters/arguments for this job.

resources

List of computational resources set for this job.

tags

Tags as joined string, delimited by “,”.

problem

Only for ExperimentRegistry: the problem identifier.

algorithm

Only for ExperimentRegistry: the algorithm identifier.

Examples

 batchtools:::example_push_temp(1) 
tmp = makeRegistry(file.dir = NA, make.default = FALSE)
#> No readable configuration file found
#> Created registry in '/tmp/batchtools-example/reg' using cluster functions 'Interactive'
f = function(x) if (x < 0) stop("x must be > 0") else sqrt(x)
batchMap(f, x = c(-1, 0, 1), reg = tmp)
#> Adding 3 jobs ...
submitJobs(reg = tmp)
#> Submitting 3 jobs in 3 chunks using cluster functions 'Interactive' ...
#> Error in (function (x)  : x must be > 0
waitForJobs(reg = tmp)
#> [1] FALSE
addJobTags(1:2, "tag1", reg = tmp)
addJobTags(2, "tag2", reg = tmp)

# Complete table:
getJobTable(reg = tmp)
#>    job.id           submitted             started                done
#> 1:      1 2020-10-21 09:39:25 2020-10-21 09:39:25 2020-10-21 09:39:25
#> 2:      2 2020-10-21 09:39:25 2020-10-21 09:39:25 2020-10-21 09:39:25
#> 3:      3 2020-10-21 09:39:25 2020-10-21 09:39:25 2020-10-21 09:39:25
#>                                      error mem.used      batch.id log.file
#> 1: Error in (function (x)  : x must be > 0       NA cfInteractive     <NA>
#> 2:                                    <NA>       NA cfInteractive     <NA>
#> 3:                                    <NA>       NA cfInteractive     <NA>
#>                               job.hash job.name      time.queued
#> 1: job5adb5742954ec70e5dc4621612e5638e     <NA> 0.002799988 secs
#> 2: job5c0144440e7359c3570442e591fd68a7     <NA> 0.002799988 secs
#> 3: jobcedfc453688181879b03f66b5e6e5f25     <NA> 0.002799988 secs
#>        time.running  job.pars resources      tags
#> 1: 0.002099991 secs <list[1]> <list[0]>      tag1
#> 2: 0.001900196 secs <list[1]> <list[0]> tag1,tag2
#> 3: 0.001899958 secs <list[1]> <list[0]>      <NA>

# Job parameters:
getJobPars(reg = tmp)
#>    job.id  job.pars
#> 1:      1 <list[1]>
#> 2:      2 <list[1]>
#> 3:      3 <list[1]>

# Set and retrieve tags:
getJobTags(reg = tmp)
#>    job.id      tags
#> 1:      1      tag1
#> 2:      2 tag1,tag2
#> 3:      3      <NA>

# Job parameters with tags right-joined:
rjoin(getJobPars(reg = tmp), getJobTags(reg = tmp))
#>    job.id  job.pars      tags
#> 1:      1 <list[1]>      tag1
#> 2:      2 <list[1]> tag1,tag2
#> 3:      3 <list[1]>      <NA>