JobNames: Set and Retrieve Job Names

JobNamesR Documentation

Set and Retrieve Job Names


Set custom names for jobs. These are passed to the template as ‘’. If no custom name is set (or any of the job names of the chunk is missing), the job hash is used as job name. Individual job names can be accessed via jobs$


setJobNames(ids = NULL, names, reg = getDefaultRegistry())

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



[data.frame or integer]
A data.frame (or data.table) with a column named “”. Alternatively, you may also pass a vector of integerish job ids. If not set, defaults to all jobs. Invalid ids are ignored.


Character vector of the same length as provided ids.


Registry. If not explicitly passed, uses the default registry (see setDefaultRegistry).


setJobNames returns NULL invisibly, getJobTable returns a data.table with columns and


tmp = makeRegistry(file.dir = NA, make.default = FALSE)
ids = batchMap(identity, 1:10, reg = tmp)
setJobNames(ids, letters[1:nrow(ids)], reg = tmp)
getJobNames(reg = tmp)

batchtools documentation built on April 20, 2023, 5:09 p.m.