isProcessRecorded: Verifies the Existence of a Recorded Process in a Thrown...

Description Usage Arguments Value See Also Examples

Description

Checks for the existence of a previously recorded process in a thrown event history.

Usage

1
isProcessRecorded(process, histname="event.history", envir=NULL)

Arguments

process

a character string defining the name of the process.

envir

the frame in S-PLUS (or environment in R) designated for the processing and storage of pipeline history data. Default: msProcessEnv, a global environment impicitly set by a previous call to throwEvent. In general, the user should rely on the specified default value.

histname

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

Value

a logical value. If TRUE, the process has already been recorded in the thrown event.

See Also

throwEvent, catchEvent, assignEvent, eventHistory.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
## throw an event 
envir <- msGlobalEnv()
throwEvent("The 2005 British Open Championship", envir=envir)

## assign data to the thrown event 
record  <- list(Winner="Tiger Woods")
process <- "champion"
assignEvent(record, process)

## verify process has been recorded: TRUE 
isProcessRecorded(process)

## catch event 
catchEvent(NULL)

## once event has been caught, isProcessRecorded returns FALSE 
isProcessRecorded(process)

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