rules-class {arules}R Documentation

Class “rules” - A Set of Rules

Description

The rules class represents a set of rules.

Note that the class can also contain a collection of rules with duplicated elements. Duplicated elements can be removed with unique.

Objects from the Class

Objects are the result of calling the function apriori. Objects can also be created by calls of the form new("rules", ...).

Slots

lhs:
Object of class itemMatrix; the left-hand-sides of the rules (antecedents)
rhs:
Object of class itemMatrix; the right-hand-sides of the rules (consequents)
quality:
Object of class "data.frame"

Extends

Class associations, directly.

Methods

coerce
signature(from = "rules", to = "data.frame"); represents the set of rules as a data.frame
itemInfo
signature(object = "rules"); returns the whole item information data frame including item labels
itemLabels
signature(object = "rules"); returns the item labels used to encode the rules
items
signature(x = "rules"); returns for each rule the union of the items in the lhs and rhs (i.e., the itemsets which generated the rule) as a the itemMatrix
labels
signature(object = "rules"); returns labels for the rules ("{lhs} => {rhs}") as a character vector
itemLabels
signature(object = "rules"); returns the item labels as a character vector. The index for each lable is the column index of the item in the binary matrix.
lhs
signature(x = "rules"); returns the itemMatrix representing the left-hand-side of the rules (antecedents)
lhs<-
signature(x = "rules"); replaces the itemMatrix representing the left-hand-side of the rules (antecedents)
rhs
signature(x = "rules"); returns the itemMatrix representing the right-hand-side of the rules (consequents)
rhs<-
signature(x = "rules"); replaces the itemMatrix representing the right-hand-side of the rules (consequents)
summary
signature(object = "rules")

See Also

apriori, associations-class, itemMatrix-class,

Examples

data("Adult")

## Mine rules.
rules <- apriori(Adult, parameter = list(support = 0.4))

## Select a subset using an item in the right-hand-side
## and a quality measure
rules.sub <- subset(rules, subset = rhs %in% "sex" & lift > 1.3)

## Display rules.
inspect(SORT(rules.sub)[1:3])

[Package arules version 0.2-5 Index]