Model Wrappers for Rule-Based Models

Bindings for additional models for use with the 'parsnip' package. Models include prediction rule ensembles (Friedman and Popescu, 2008) , C5.0 rules (Quinlan, 1992 ISBN: 1558602380), and Cubist (Kuhn and Johnson, 2013) .


rules rules website

Lifecycle:experimental R-CMD-check Codecov testcoverage CRANstatus

Introduction

rules is a parsnip extension package with model definitions for rule-based models, including:

  • cubist models that have discrete rule sets that contain linear models with an ensemble method similar to boosting
  • classification rules where a ruleset is derived from an initial tree fit
  • rule-fit models that begin with rules extracted from a tree ensemble which are then added to a regularized linear or logistic regression.

Installation

You can install the released version of rules from CRAN with:

install.packages("rules")

Install the development version from GitHub with:

# install.packages("pak")
pak::pak("tidymodels/rules")

Available Engines

The rules package provides engines for the models in the following table.

model engine mode
C5_rules C5.0 classification
cubist_rules Cubist regression
rule_fit xrf classification
rule_fit xrf regression

Contributing

This project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("rules")

1.0.3 by Emil Hvitfeldt, 9 months ago


https://github.com/tidymodels/rules, https://rules.tidymodels.org/


Report a bug at https://github.com/tidymodels/rules/issues


Browse source code at https://github.com/cran/rules


Authors: Emil Hvitfeldt [aut, cre] (ORCID: , Max Kuhn [aut] , Posit Software , PBC [cph, fnd] (ROR: <https://ror.org/03wc8by49>)


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports cli, dials, dplyr, generics, purrr, rlang, stats, stringr, tidyr, utils

Depends on parsnip

Suggests C50, covr, Cubist, knitr, modeldata, recipes, rmarkdown, spelling, testthat, tibble, xrf


Imported by finnts.

Suggested by Cubist, orbital, tidyAML, tidypredict, viralx.


See at CRAN