R: Export Objects to the Slaves

batchExport {batchtools} | R Documentation

## Export Objects to the Slaves

### Description

Objects are saved in subdirectory “exports” of the “file.dir” of `reg`. They are automatically loaded and placed in the global environment each time the registry is loaded or a job collection is executed.

### Usage

    batchExport(export = list(), unexport = character(0L),
      reg = getDefaultRegistry())

### Arguments

`export` | [`list`] Named list of objects to export.
`unexport` | [`character`] Vector of object names to unexport.
`reg` | [`Registry`] Registry. If not explicitly passed, uses the default registry (see `setDefaultRegistry`).

### Value

[`data.table`] with name and uri to the exported objects.

### Examples

    tmp = makeRegistry(file.dir = NA, make.default = FALSE)

    # list exports
    exports = batchExport(reg = tmp)
    print(exports)

    # add a job and required exports
    batchMap(function(x) x^2 + y + z, x = 1:3, reg = tmp)
    exports = batchExport(export = list(y = 99, z = 1), reg = tmp)
    print(exports)

    submitJobs(reg = tmp)
    waitForJobs(reg = tmp)
    stopifnot(loadResult(1, reg = tmp) == 101)

    # Un-export z
    exports = batchExport(unexport = "z", reg = tmp)
    print(exports)

[Package batchtools version 0.9.11 Index]