diff --git a/README.md b/README.md index caf14d4..d75ee7e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,26 @@ # randomForestExplainer -Set of tools to understand what is happening inside a Random Forest. A detailed discussion of the package and importance measures it implements can be found here: [Master thesis on randomForestExplainer](https://rawgit.com/geneticsMiNIng/BlackBoxOpener/master/randomForestExplainer_Master_thesis.pdf). +[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/randomForestExplainer)](https://cran.r-project.org/package=factorMerger) +[![Pending Pull-Requests](http://githubbadges.herokuapp.com/MI2DataLab/randomForestExplainer/pulls.svg)](https://github.com/MI2DataLab/randomForestExplainer/pulls) +[![Github Issues](http://githubbadges.herokuapp.com/MI2DataLab/randomForestExplainer/issues.svg)](https://github.com/MI2DataLab/randomForestExplainer/issues) + +A set of tools to understand what is happening inside a Random Forest. A detailed discussion of the package and importance measures it implements can be found here: [Master thesis on randomForestExplainer](https://rawgit.com/geneticsMiNIng/BlackBoxOpener/master/randomForestExplainer_Master_thesis.pdf). ## Instalation +randomForestExplainer can be installed from [CRAN](https://cran.r-project.org/package=randomForestExplainer) as follows: + +```{r} +install.packages("randomForestExplainer") ``` + +To install and load the latest version of `https://cran.r-project.org/package=randomForestExplainer` from **Github** run: + +```{r} +if (!require(devtools)) install.packages("devtools") devtools::install_github("MI2DataLab/randomForestExplainer") + +library(randomForestExplainer) ``` ## Vignette