improves help

ModelOriented · Dec 14, 2018 · 6e71f5c · 6e71f5c
1 parent 7f0d9e3
commit 6e71f5c
Show file tree

Hide file tree

Showing 9 changed files with 198 additions and 3 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: localModel
 Title: LIME-based Explanations With Interpretable Inputs Based on Ceteris Paribus Profiles
-Version: 0.2.5
+Version: 0.2.6
 Authors@R: person("Mateusz", "Staniak", email = "m.staniak@mini.pw.edu.pl", role = c("aut", "cre"))
 Description: Local explanations of machine learning models describe, how features contributed
   to a single prediction. This package implements LIME-like explanation method 
@@ -13,7 +13,6 @@ License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
 Imports: glmnet,
-    forestmodel,
     ceterisParibus,
     stringr,
     ggplot2,

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,7 @@
+# localModel 0.2.6
+
+* Adds help for the package.
+
 # localModel 0.2.5
 
 * Fixes bug related to number of levels when sampling new observation.

diff --git a/R/localModel.R b/R/localModel.R
@@ -0,0 +1,14 @@
+#' localModel: LIME-like explanations with interpretable features based on Ceteris Paribus profiles
+#'
+#' This package implements LIME-like explanation method
+#' (see Tulio Ribeiro, Singh, Guestrin (2016) <doi:10.1145/2939672.2939778>) in which interpretable
+#' inputs are created based on local rather than global behaviour of each original feature.#'
+#'
+#' @section Important functions:
+#' \code{\link{individual_surrogate_model}} generates an explanation for a single prediction with
+#' interpretable features based on Ceteris Paribus profiles.
+#' \code{\link{plot.local_surrogate_explainer}} plots the explanation.
+#'
+#' @docType package
+#' @name localModel
+NULL
diff --git a/docs/articles/classification_example_files/figure-html/explanation-1.png b/docs/articles/classification_example_files/figure-html/explanation-1.png
diff --git a/docs/articles/regression_example_files/figure-html/plot-1.png b/docs/articles/regression_example_files/figure-html/plot-1.png
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/localModel.html b/docs/reference/localModel.html
diff --git a/man/localModel.Rd b/man/localModel.Rd