record: Record data provenance for an R script exection

Description Usage Arguments Details Value See Also Examples

Description

The R script is executed and information about file reads and writes is recorded.

Usage

1
2
3
4
record(recordr, file, ...)

## S4 method for signature 'Recordr'
record(recordr, file, tag = "", ...)

Arguments

recordr

a Recordr instance

file

The name of the R script to run and collect provenance information for

...

additional parameters that will be passed to the R "base::source()" function

tag

A string that will be associated with this run

Details

Input files, the script itself and igenerated files are archived. Information about the execution environment is also saved.

Value

The execution identifier for this run

See Also

Recordr class description

Examples

1
2
3
4
5
## Not run: 
rc <- new("Recordr")
executionId <- record(rc, file="myscript.R", tag="first run of myscript.R")

## End(Not run)

NCEAS/recordr documentation built on May 7, 2019, 5:59 p.m.