logEvent: Formats an event description to be sent for attaching to the...

In hyginn/rete: Network Analysis for Cell- and Systems Biology

Description

logEvent generates an event message with: - the event title - the event call - attributes of the input object - attributes of the output object - date and time of the event - function version (TODO) - file hashes of input (TODO)

Usage

logEvent(eventTitle, eventCall, input = character(), notes = character(),
  output = character())

Arguments

eventTitle	the title of the event, from a predetermined categorization of events
eventCall	the function call in which the event occurred
input	vector of object names with an "input" role in the calling function's workflow
notes	a vector of strings comprising text to be incorporated into the event description.
output	vector of object names with an "output" role in the calling function's workflow

Details

Format of the event description is as follows: event | title | <eventTitle> event | time | <eventDateTime> event | call | <eventCall> (ToDo: event | functionVersion | <functionVersion>) event | input | attribute | <inputAttrName1> | <inputAttrValue1> event | output | attribute | <outputAttrName1> | <outputAttrValue1> event | end

The event message is terminated by an "end event" marker, and a blank line, and it is handed off to logMessage() to append it to the log file referenced in the global variable options("rete.logfile")

Value

N/A A message is appended to the log file via logMessage.

Examples

## Not run: 
    logEvent(eventTitle = "Test event",
             eventCall = "function1(test = \"test\")")

## End(Not run)

hyginn/rete documentation built on May 17, 2019, 9:16 p.m.