README.md

In mi-erasmusmc/AssociationRuleMining: What the Package Does (One Line, Title Case)

AssocationRuleMining

Introduction

An R package under development, for mining and analysing association rules and frequent patterns using data in the OMOP Common Data Model format.

Features

• Implements association rule mining algorithms.
• Implements frequent pattern mining algorithms.

Technology

AssociationRuleMining is implemented in R, making use of SPMF, an open source data mining library written in Java. More to come soon...

System Requirements

Requires R (version 3.4.0 and above) and Java.

Getting Started

• Advanced users are encouraged to have a look at An introduction for the advanced user, for a quick overview and how to use the package.

• In the directory /extras there are available .R and .Rmd files ready to be executed against any OMOP-CDM database, once the necessary fields are filled in.

For examples of the complete workflow using the Eunomia package, have a look at

• An example to extract association rules us- An example to extract frequent patterns.

User Documentation

• In production.

Support

• Use GitHub issue tracker

Contributing

• To be announced.

Licence

Development

AssociationRuleMining is being developed in R Studio.

Acknowledgements

mi-erasmusmc/AssociationRuleMining documentation built on Oct. 26, 2021, 1:31 a.m.