tests and docs for v1.5.8

NEWS.md

@@ -1,9 +1,9 @@
 # live 1.5.8
 
 * Allow setting seed before sampling in `sample_locally2` to make results reproducible.
-* Add new explainer: `local_permutation_importance` function.d
-* Fixed problems with mlr dependency
-* Add shortcut function for DALEX explainers
+* Add new explainer: `local_permutation_importance` function.
+* Fixed problems with mlr dependency.
+* Add shortcut function for DALEX explainers: `local_approximation`.
 
 # live 1.5.7
 

R/dalex_shortcut.R

@@ -12,8 +12,20 @@
 #' @param kernel_type Function which will be used to calculate distances from
 #' simulated observation to explained instance
 #' @param ... Arguments to be passed to sample_locally2 function
+#' 
+#' @return object of class live_explainer. More details in fit_explanation2 function help.
 #'
 #' @export
+#' 
+#' @examples
+#' \dontrun{
+#' data('wine')
+#' library(randomForest)
+#' library(DALEX)
+#' rf <- randomForest(quality~., data = wine)
+#' expl <- explain(rf, wine, wine$quality)
+#' live_expl <- local_approximation(expl, wine[5, ], "quality", 500)
+#' }
 #'
 
 local_approximation <- function(explainer, observation, target_variable_name,

tests/testthat.R

@@ -1,8 +1,9 @@
 library(testthat)
 library(live)
 library(mlr)
-library(data.table)
 library(lubridate)
+library(DALEX)
+library(data.table)
 
 set.seed(1)
 X <- as.data.frame(matrix(runif(5500), ncol = 11, nrow = 500))

tests/testthat/test_shortcut.R

@@ -0,0 +1,11 @@
+context("Test shortcut for DALEX explainers")
+
+mlm <- lm(quality ~., data = live::wine)
+expl <- DALEX::explain(mlm, live::wine, live::wine$quality)
+
+testthat::test_that("DALEX integration is okay", {
+  testthat::expect_is(
+    local_approximation(expl, live::wine[5, ], "quality", 500),
+    "live_explainer"
+    )
+})