R/07AnalysisComponent.R

In preprocomb: Tools for Preprocessing Combinations

#' @include 06PreProCombClass.R
NULL

#' shows association rules for classification accuracy.
#'
#' Classification accuracy label  'high' corresponds to best twenty
#' percent and 'low' for the rest.

#' @param PreProCombClassobject (PreProCombClass)
#' @param support (numeric) support for association rules, default to 0.05
#' @param confidence (numeric) confidence for association rules, defaults to 0.5
#' @export

showrules <- function(PreProCombClassobject, support=0.05, confidence=0.5){

  if(class(PreProCombClassobject)!="PreProCombClass"){stop("The argument 'PreProCombClassobject' must be a PreProCombClass object.")}
  if(all(PreProCombClassobject@catclassification==0)){stop("The argument 'PreProCombClassobject' does not contain classification results.")}

  rules <- arules::apriori(PreProCombClassobject@catclassification, parameter = list(support = support, confidence = confidence), appearance=list(rhs='target=high', default='lhs'))
  arules::inspect(rules)
}