R: Set and Retrieve Job Names

JobNames {batchtools} | R Documentation

## Set and Retrieve Job Names

### Description

Set custom names for jobs. These are passed to the template as ‘job.name’. 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$job.name`.

### Usage

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

    getJobNames(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.
`names` | [`character`] Character vector of the same length as provided ids.
`reg` | [`Registry`] Registry. If not explicitly passed, uses the default registry (see `setDefaultRegistry`).

### Value

`setJobNames` returns `NULL` invisibly, `getJobTable` returns a `data.table` with columns `job.id` and `job.name`.

### Examples

    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)

[Package batchtools version 0.9.11 Index]