R: Sequence Detector Method: processing input data streams

process,HybridSequenceClassifier-method {SeqDetect}

R Documentation

Sequence Detector Method: processing input data streams

Description

Sequence Detector method for processing of input data streams. See the SeqDetect vignette for proper usage and cases.

Usage

## S4 method for signature 'HybridSequenceClassifier'
process(streams,learn=TRUE,give_explain=TRUE,threshold=NULL,debug=FALSE,
out_filename=NULL, ...)

Arguments

`streams`	(list, data.frame) - A named list that comprises input data streams. Each list element is a data frame that represents one input data stream.
`learn`	(logical) - Are ETTs in the Sequence Detector extendable? If TRUE, the Sequence Detector learns new sequences from the supplied input data streams.
`give_explain`	(logical) - Determines elements that will be returned by the method. If TRUE, output explanation and sequence statistical analysis will be returned as well.
`threshold`	(integer) - Needed threshold for the pushing mechanism. Pushing will work only for transitions that are above the supplied threshold. If NULL, all transitions are taken in consideration.
`debug`	(logical) - A switch for debug printout.
`out_filename`	(character) - A filename where the consolidated data stream should be written. The written file is in the CSV format. If NULL, file writing is skipped.
`...`	- An additional list of parameters passed into pre-processor and pre-classifier.

Value

A list that comprises the following elements:

stream - The consolidated stream.

If give_explain is TRUE then an additional element is:

explanation - Actual and potential output symbols for each data item of the consolidated data stream.

If give_explain is TRUE and time_series_sequence_stats is TRUE then an additional element is:

sequences - The complete sequence statistics for the input time-series data.

Examples

st <- data.frame(product=c("P45","P134","P45","P134","P134","P45","P134"),
                 sales=c(2,12,18,16,18,24,8),
                 alert=c(NA,NA,NA,NA,NA,"Alert P45","Alert P134"))
input_streams <- list(stream=st)
pp <- HSC_PP(c("product","sales"),"sequence_id",auto_id=TRUE)
pc <- HSC_PC_Binning(0,100,40,"sales")
hsc <- HybridSequenceClassifier(c("product","sales","sequence_id"),
       "sequence_id","sequence_id","product",pc,pp)
res <- hsc$process(input_streams)
message(res)