viewRuns: View detailed information for an execution

In NCEAS/recordr: R Provenance Tracking

Description

Detailed information for an execution is printed to the display.

Usage

viewRuns(recordr, ...)

## S4 method for signature 'Recordr'
viewRuns(recordr, id = as.character(NA),
  file = as.character(NA), start = as.character(NA),
  end = as.character(NA), tag = as.character(NA),
  error = as.character(NA), seq = as.character(NA),
  orderBy = "-startTime", sections = c("details", "used", "generated"),
  verbose = FALSE, page = TRUE, output = TRUE)

Arguments

recordr	A Recordr instance
...	additional parameter
id	The execution identifier of a run to view
file	The name of script to match
start	Match runs that started in this time range (inclusive) Times must be entered in the form 'YYYY-MM-DD HH:MM:SS' but can be shortened to not less that "YYYY"
end	Match runs that ended in this time range (inclusive) Times must be entered in the form 'YYYY-MM-DD HH:MM:SS' but can be shortened to not less that "YYYY"
tag	The text of tag to match
error	The text of error message to match.
seq	A run sequence number (can be a range, e.g seq=1:10)
orderBy	Sort the results according to the specified column. A hypen ('-') prepended to the column name denoes a descending sort. The default value is "-startTime"
sections	Print the specified sections of the output. Default=c("details", "used", "generated")
verbose	a "logical", if TRUE then extra information is printed.
page	A logical value - if TRUE then pause after each run is displayed.
output	a "logical", if FALSE then no output is printed to the console (useful if only the returned object is needed).

Details

The execution and file information for runs that match the search criteria are printed to the console. The output is divided into three sections: "details", "used" and "generated". The "details" section shows execution information such as the start and end time of the run, run identifier, etc. The "used" section lists files that were read by a run. The "generated" section lists files that were created by a run. The list that is returned from "viewRuns" contains two elements - a data.frame with the execution information, and a data.frame that contains file information.

Value

A list that contains information about all selected runs.

See Also

Recordr class description

Examples

## Not run: 
rc <- new("Recordr")
# View the tenth run that was recorded
viewRuns(rc, seq=10)
# View the first ten runs, with only the files "generated" section displayed
info <- viewRuns(rc, seq="1:10", sections="generated")
nrow(info$runs)
nrow(info$files)

## End(Not run)

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