README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

# broomstick

<!-- badges: start -->
[![R build status](https://github.com/njtierney/broomstick/workflows/R-CMD-check/badge.svg)](https://github.com/njtierney/broomstick/actions)
[![Codecov test coverage](https://codecov.io/gh/njtierney/broomstick/branch/master/graph/badge.svg)](https://codecov.io/gh/njtierney/broomstick?branch=master)
[![R-CMD-check](https://github.com/njtierney/broomstick/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/njtierney/broomstick/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

Convert decision tree objects into tidy data frames with `broomstick`.

The goal of broomstick is to extend the [`broom`](https://github.com/tidyverse/broom) package to work with decision trees. It is currently borrowing heavily from the prototype package [`treezy`](https://github.com/njtierney/treezy).

## Installation

You can install broomstick from github with:

```{r gh-installation, eval = FALSE}
# install.packages("remotes")
remotes::install_github("njtierney/broomstick")
```

## Examples

## rpart

```{r example-rpart}
library(rpart)
library(broomstick)

fit_rpart <- rpart(Kyphosis ~ Age + Number + Start, 
                   data = kyphosis)

tidy(fit_rpart)
augment(fit_rpart)
```


## gbm (Boosted Regression Tree)

```{r example-gbm}
library(gbm)
library(MASS)
fit_gbm <- gbm(calories ~., data = UScereal)

tidy(fit_gbm)
```

## random forest

```{r example-rf}
library(randomForest)
ozone_rf <- randomForest(Ozone ~ ., 
                         data = airquality, 
                         importance = TRUE,
                         na.action = na.omit)
tidy(ozone_rf)
glance(ozone_rf)
augment(ozone_rf)
```