plotRuns: Trace processing lineage for a run and plot it.

Description Usage Arguments Details Value See Also Examples

Description

A data processing workflow might include multiple processing steps, with each step being performed by a separate R script. These multiple steps are linked by the files that one step writes and the next step in the workflow reads. The plotRuns method finds these connections between executions to determine the executions that comprise a processing workflow.

Usage

1
2
3
4
5
6
7
8
plotRuns(recordr, ...)

## S4 method for signature 'Recordr'
plotRuns(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", direction = "both", quiet = TRUE, ...)

Arguments

recordr

a Recordr instance

...

additional parameters

id

The identifier for a run. Either id or seq can be specified, not both.

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

The sequence number for a run. #' @param id The execution identifier of a run to view

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"

direction

The direction to trace the lineage, either fowward, backward, or both. The default is both

quiet

A logical if TRUE then output is not printed.

Details

If the run id or seq number is know for the run to be traced, then one or the other of these values can be used. Alternatively, other run attributes can be used to determine the run to be traced, such as file, start, etc. If these other search parameters are used and multiple runs are selected, only the first run selected will be traced. These search parameters can be used together to easily find certain runs, for example, the latest run of a particular script, the latest run with a specified tag specified, etc. (see examples).

Value

A list of the execution identifiers that are in the processing workflow.

See Also

Recordr class description

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# Plot processing workflow for the run with sequence number '101'
plotRuns(recordr, seq=101)
# Plot processing workflow for the last execution of script "runModel.R"
plotRuns(recordr, file="runModel.R", orderBy="-startTime")
# Plot processing workflow for the last execution with the tag 'best run yet!' specified.
plotRuns(recordr, tag="best run yet!", orderBy="-startTime")

## End(Not run)

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