SPcontrol-class {arulesSequences}

Class "SPcontrol" — cSPADE Control Parameters

Description

Provides control parameters for the cSPADE algorithm for mining frequent sequences.

Objects from the Class

A suitable default parameter object will be automatically created by a call to cspade. However, the values can be replaced by specifying a named list with the names (partially) matching the slot names of the SPparameter class.

Objects can be created by calls of the form new("SPcontrol", ...).

Slots

memsize:

an integer value specifying the maximum amount of memory to use (default none [32 MB], range >= 16).

numpart:

an integer value specifying the number of database partitions to use (default auto, range >= 1).

timeout:

an integer value specifying the maximum runtime in seconds (default none, range >= 1).

bfstype:

a logical value specifying if a breadth-first type of search should be performed (default FALSE [DFS]).

verbose:

a logical value specifying if progress and runtime information should be displayed (default FALSE).

summary:

a logical value specifying if summary information should be preserved (default FALSE).

tidLists:

a logical value specifying if transaction ID lists should be included in the result (default FALSE).

Methods

coerce

signature(from = "NULL", to = "SPcontrol")

coerce

signature(from = "list", to = "SPcontrol")

coerce

signature(from = "SPcontrol", to = "character")

coerce

signature(from = "SPcontrol", to = "data.frame")

coerce

signature(from = "SPcontrol", to = "list")

coerce

signature(from = "SPcontrol", to = "vector")

format

signature(x = "SPcontrol")

Note

User-supplied values are silently coerced to the target class, e.g. integer.

Parameters with no (default) value are not supplied to the mining algorithm, i.e., take the default values implemented there. A default can be unset using NULL.

The value of memsize implicitly determines the number of database partitions used unless overridden by numpart. Usually, the more partitions the less the runtime in the mining stage. However, there may be a trade-off with preprocessing time.

If summary = TRUE informational output from the system calls in the preprocessing and mining steps will be preserved in the file summary.out in the current working directory.

Author(s)

Christian Buchta

See Also

Class SPparameter, function cspade.

Examples

## coerce from list 
p <- as(list(verbose = TRUE), "SPcontrol")
p

## coerce to
as(p, "vector")
as(p, "data.frame")