recordr (version 1.0.3)

listRuns: List all runs recorded by record() or startRecord()

Description

If no search terms are specified, then all runs are listed. The method arguments are search terms that limit the runs listed, with anly runs listed that match all arguments.

Usage

listRuns(recordr, ...)
"listRuns"(recordr, id = as.character(NA), script = 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", quiet = FALSE)

Arguments

recordr

A Recordr instance

...

additional parameters

id

a "character", the identifier to match

script

"character",the name of the script to match

start

"character", 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

a "character", 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

"character" Text of tag to match

error

"character" Text of error message to match

seq

"integer" A run sequence number (can be a range, e.g seq=1:10)

orderBy

The column that will be used to sort the output. This can include a minus sign before the name, e.g. -startTime

quiet

A logical, if TRUE then output is not printed to the console. Default is FALSE.

Value

data frame containing information for each run

Details

The "start" and "end" parameters can be used to specify a time range to find runs that started execution and ended in the specified time range. For examples, specifying "start=c("2015-01-01, "2015-01-31") will cause the search to return any execution with a starting time in the first month of 2015.

See Also

Recordr class description

Examples

## Not run: 
# rc <- new("Recordr")
# # List runs that started in January 2015
# listRuns(rc, start=c("2015-01-01", "2015-01-31"))
# # List runs that started on or after March 1, 2014
# listruns(rc, start="2014-03-01")
# # List runs that contain a tag with the string "analysis v1.3")
# listRuns(rc, tag="analysis v1.3")
# ## End(Not run)