ASparameter-classes: Classes ASparameter, APparameter, ECparameter --- Specifying the parameter Argument of apriori() and eclat()

Description

The ASparameter class holds the mining parameters (e.g., minimum support) for the used mining algorithms. APparameter and ECparameter directly extend ASparameter with additional slots for parameters only suitable for the Apriori (APparameter) or the Eclat algorithms (ECparameter).

Arguments

Objects from the Class

A suitable default parameter object will be automatically created by the apriori or the eclat function. By specifying a named list (names equal to slots) as parameter argument for the apriori or the eclat function, default values can be replaced by the values in the list. Objects can be created by calls of the form new("APparameter", ...) or new("ECparameter", ...).

Slots

Common slots defined in ASparameter:

support:

a numeric value for the minimal support of an item set (default: \(0.1\))

minlen:

an integer value for the minimal number of items per item set (default: 1 item)

maxlen:

an integer value for the maximal number of items per item set (default: 10 items)

target:

a character string indicating the type of association mined. One of

"frequent itemsets"
"maximally frequent itemsets"
"closed frequent itemsets"
"rules" (only available for Apriori; use ruleInduction for eclat.)
"hyperedgesets" (only available for Apriori; see references for the definition of association hyperedgesets)

ext:

a logical indicating whether to report coverage (i.e., LHS-support) as an extended quality measure (default: TRUE)

Additional slots for Apriori in APparameter:

confidence:

a numeric value for the minimal confidence of rules/association hyperedges (default: \(0.8\)). For frequent itemsets it is set to NA.

smax:

a numeric value for the maximal support of itemsets/rules/hyperedgesets (default: 1)

arem:

a character string indicating the used additional rule evaluation measure (default: "none") given by one of

"none":: no additional evaluation measure
"diff":: absolute confidence difference
"quot":: difference of confidence quotient to 1
"aimp":: absolute difference of improvement to 1
"info":: information difference to prior
"chi2":: normalized \(\chi^2\) measure

Note: The measure is only reported if aval is set to TRUE. Use minval to set minimum thresholds on the measures.

aval:

a logical indicating whether to return the additional rule evaluation measure selected with arem.

minval:

a numeric value for the minimal value of additional evaluation measure selected with arem (default: \(0.1\))

originalSupport:

a logical indicating whether to use the original definition of minimum support (support of the LHS and RHS of the rule). If set to FALSE then a minimum threshold on coverage (i.e., the support of the LHS) is used instead. (default: TRUE)

maxtime:

Time limit in seconds for checking subsets. maxtime = 0 disables the time limit. (default: 5 seconds)

Additional slots for Eclat in ECparameter:

tidLists:: a logical indicating whether to return also a list of supporting transactions (transaction IDs) (default: FALSE)

Methods

coerce: signature(from = "NULL", to = "APparameter")
coerce: signature(from = "list", to = "APparameter")
coerce: signature(from = "NULL", to = "ECparameter")
coerce: signature(from = "list", to = "ECparameter")
show: signature(object = "ASparameter")

References

Christian Borgelt (2004) Apriori --- Finding Association Rules/Hyperedges with the Apriori Algorithm. https://borgelt.net/apriori.html