R: Remove Experiments

removeExperiments {batchtools} | R Documentation

## Remove Experiments

### Description

Remove Experiments from an `ExperimentRegistry`. This function automatically checks if any of the jobs to reset is either pending or running. However, if the implemented heuristic fails, this can lead to inconsistencies in the data base. Use with care while jobs are running.

### Usage

    removeExperiments(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 no job. Invalid ids are ignored.
`reg` | [`ExperimentRegistry`] Registry. If not explicitly passed, uses the last created registry.

### Value

[`data.table`] of removed job ids, invisibly.

### See Also

Other Experiment: `addExperiments`, `summarizeExperiments`

[Package batchtools version 0.9.11 Index]