run_apriori_rules {RareComb}

Generate rules using the apriori algorithm

Description

This function takes in a factorized Boolean matrix and generate rules that meet all the user provided criteria while restricting the RHS of the rule based on the list of variables allowed in RHS provided by the calling function.

Usage

run_apriori_rules(
  apriori_input_df,
  combo_length,
  support_threshold,
  input_colname_list,
  confidence_threshold = confidence_threshold,
  output_colname_list = output_colname_list
)

Arguments

apriori_input_df

An input factorized Boolean dataframe with multiple input and outcome variables

combo_length

The length of the combinations specified by the user

support_threshold

Minimum support value calculated based on the minimum absolute observed frequency threshold specified by the user

input_colname_list

A list of column names that identify the input variables

confidence_threshold

Minimum confidence threshold specified by the user

output_colname_list

Optional | A list of column names that identify the outcome variables

Details

This is a function leveraged by few of the four main methods available to the users.

Value

A list of rules that meet all the constraints supplied to the apriori algorithm

Author(s)

Vijay Kumar Pounraja