throwEvent: Throw a History Event to a Specified Frame

Description Usage Arguments Value See Also Examples

Description

Throws a history event with a specified name to a specified frame in S-PLUS (or environment in R). Typically, this function will be issued within a caller with the expectation that the thrown history will be added to by the callee(s). The history can then be caught by the caller using the catchHistory function.

Usage

1
throwEvent(x, histname="event.history", envir=msNewEnv())

Arguments

x

a character string defining the event.

envir

the frame in S-PLUS (or environment in R) designated for the processing and storage of pipeline history data. Default: msNewEnv().

histname

a character string defining the name of the history variable stored in the specified frame. Default: "event.history".

Value

a list named histname containing the following objects is written to the specified frame.

name

A character string defining the name of the event.

history

The actual history object.

recorded

A vector of chacter strings maintaining a record of all processes that have been recorded for the event.

Typically, these list objects will not be accessed directly by the user. Rather, this information is updated and retrieved via the throwEvent and catchEvent function.

See Also

catchEvent, assignEvent, isProcessRecorded, eventHistory.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## throw an event 
envir <- msGlobalEnv()
throwEvent("Wimbledon 2005", envir=envir)

## assign data to the thrown event 
record  <- list(Men="Roger Federer", Women="Venus Williams")
assignEvent(record)

## catch event 
catchEvent(NULL)

zeehio/msProcess documentation built on May 4, 2019, 10:15 p.m.