recordr (version 1.0.3)

startRecord: Begin recording provenance for an R session.

Description

This method starts the recording process and the method endRecord() completes it.

Usage

startRecord(recordr, ...)
"startRecord"(recordr, tag = list(), .file = as.character(NA), .console = TRUE)

Arguments

recordr

a Recordr instance

...

additional parameters

tag

a string that is associated with this run

.file

the filename for the script to run (only used internally when startRecord() is called from record())

.console

a logical argument that is used internally by the recordr package

Value

execution identifier that uniquely identifies this recorded session

Details

The startRecord() method can be called from the R console to begin a recording session during which provenance is captured for any functions that are inspected by Recordr. This recordr session can be closed by calling the endRecord() method. When the record() function is called to record a script, the startRecord() function is called automatically.

See Also

Recordr class description

Examples

## Not run: 
# rc <- new("Recordr")
# startRecord(rc, tag="my first console run")
# x <- read.csv(file="./test.csv")
# runIdentifier <- endRecord(rc)
# ## End(Not run)