forked from bgreenwell/pdp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
99 lines (75 loc) · 5.37 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
---
output:
md_document:
variant: markdown_github
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "tools/README-"
)
```
[](https://cran.r-project.org/package=pdp)
[](https://travis-ci.org/bgreenwell/pdp)
[](https://codecov.io/github/bgreenwell/pdp?branch=master)
[](http://cranlogs.r-pkg.org/badges/pdp)
[](http://cranlogs.r-pkg.org/badges/grand-total/pdp)
[](http://www.rdocumentation.org/packages/pdp)
# pdp: An R Package for Constructing Partial Dependence Plots
Complex nonparametric models---like neural networks, random forests, and support vector machines---are more common than ever in predictive analytics, especially when dealing with large observational databases that don't adhere to the strict assumptions imposed by traditional statistical techniques (e.g., multiple linear regression which assumes linearity, homoscedasticity, and normality). Unfortunately, it can be challenging to understand the results of such models and explain them to management. Partial dependence plots offer a simple solution. Partial dependence plots are low-dimensional graphical renderings of the prediction function $\widehat{f}\left(\boldsymbol{x}\right)$ so that the relationship between the outcome and predictors of interest can be more easily understood. These plots are especially useful in explaining the output from black box models. The `pdp` package offers a general framework for constructing partial dependence plots for various types of fitted models in R.
A detailed introduction to `pdp` has been accepted for publication in The R Journal; a preprint is available [here](https://journal.r-project.org/archive/2017/RJ-2017-016/index.html). You can track development on at https://github.com/bgreenwell/pdp. To report bugs or issues, contact the main author directly or submit them to https://github.com/bgreenwell/pdp/issues.
As of right now, `pdp` exports four functions:
* `partial` - compute partial dependence functions (i.e., objects of class `"partial"`) from various fitted model objects;
* `plotPartial"` - plot partial dependence functions (i.e., objects of class `"partial"`) using `lattice` graphics;
* `autoplot` - plot partial dependence functions (i.e., objects of class `"partial"`) using `ggplot2` graphics;
* `topPredictors` extract most "important" predictors from various types of fitted models.
## Installation
The `pdp` package is [currently listed on CRAN](https://CRAN.R-project.org/package=pdp) and can easily be installed:
```r
# Install from CRAN (recommended)
install.packages("pdp")
# Alternatively, install the development version from GitHub
devtools::install_github("bgreenwell/pdp")
```
## Random forest example
As a first example, we'll fit a random forest to the famous Boston housing data included with the package (see `?boston` for details). In fact the original motivation for this package was to be able to compute two-predictor partial dependence plots from random forest models in R.
```{r example-rf, fig.width=8, fig.height=4, message=FALSE}
# Fit a random forest to the Boston housing data
library(randomForest) # install.packages("randomForest")
data (boston) # load the boston housing data
set.seed(101) # for reproducibility
boston.rf <- randomForest(cmedv ~ ., data = boston)
# Partial dependence of cmedv on lstat and rm
library(pdp)
pd <- partial(boston.rf, pred.var = c("lstat", "rm"), chull = TRUE)
head(pd) # print first 6 rows
# Lattice version
p1 <- plotPartial(pd, main = "lattice version")
# ggplot2 version
library(ggplot2)
p2 <- autoplot(pd, contour = TRUE, main = "ggplot2 version",
legend.title = "Partial\ndependence")
# Show both plots in one figure
grid.arrange(p1, p2, ncol = 2)
```
Next, we'll fit a classification model to the Pima Indians Diabetes data.
## Support vector machine (SVM) example
As a second example, we'll fit an SVM to the Pima Indians diabetes data included with the package (see `?pima` for details). Note that for some fitted model objects (e.g., `"ksvm"` objects) it is necessary to supply the original training data via the `train` argument in the call to `partial`.
```{r example-svm, fig.width=8, fig.height=4, message=FALSE}
# Fit an SVM to the Pima Indians diabetes data
library(kernlab) # install.packages("kernlab")
data (pima) # load the Pima Indians diabetes data
pima.svm <- ksvm(diabetes ~ ., data = pima, type = "C-svc", kernel = "rbfdot",
C = 0.5, prob.model = TRUE)
# Partial dependence of diabetes test result on glucose (default is logit scale)
pd.glucose <- partial(pima.svm, pred.var = "glucose", train = pima)
# Partial dependence of diabetes test result on glucose (probability scale)
pd.glucose.prob <- partial(pima.svm, pred.var = "glucose", prob = TRUE,
train = pima)
# Show both plots in one figure
grid.arrange(autoplot(pd.glucose, main = "Logit scale"),
autoplot(pd.glucose.prob, main = "Probability scale"),
ncol = 2)
```