fix cran

ModelOriented · Sep 10, 2020 · 85b6927 · 85b6927
1 parent ed3c700
commit 85b6927
Show file tree

Hide file tree

Showing 13 changed files with 83 additions and 66 deletions.
diff --git a/R/modelStudio.R b/R/modelStudio.R
@@ -42,7 +42,7 @@
 #' @param eda Compute EDA plots and Residuals vs Feature plot, which adds the data to the dashboard. Default is \code{TRUE}.
 #' @param show_info Verbose a progress on the console. Default is \code{TRUE}.
 #' @param parallel Speed up the computation using \code{parallelMap::parallelMap()}.
-#'  See \href{https://modeloriented.github.io/modelStudio/articles/ms-perks-features.html#parallel-computation}{\bold{vignette}}.
+#'  See \href{https://modelstudio.drwhy.ai/articles/ms-perks-features.html#parallel-computation}{\bold{vignette}}.
 #'  This might interfere with showing progress using \code{show_info}.
 #' @param options Customize \code{modelStudio}. See \code{\link{ms_options}} and
 #'  \href{https://modelstudio.drwhy.ai/articles/ms-perks-features.html#additional-options-1}{\bold{vignette}}.
@@ -74,8 +74,8 @@
 #' }
 #'
 #' @seealso
-#' Vignettes: \href{https://modeloriented.github.io/modelStudio/articles/ms-r-python-examples.html}{\bold{modelStudio - R & Python examples}}
-#' and \href{https://modeloriented.github.io/modelStudio/articles/ms-perks-features.html}{\bold{modelStudio - perks and features}}
+#' Vignettes: \href{https://modelstudio.drwhy.ai/articles/ms-r-python-examples.html}{\bold{modelStudio - R & Python examples}}
+#' and \href{https://modelstudio.drwhy.ai/articles/ms-perks-features.html}{\bold{modelStudio - perks and features}}
 #'
 #' @examples
 #' library("DALEX")
@@ -98,7 +98,8 @@
 #'
 #' # make a studio for the model
 #' modelStudio(explainer_titanic,
-#'             new_observations)
+#'             new_observations,
+#'             N = 200,  B = 5) # faster example
 #'
 #' \donttest{
 #'

diff --git a/R/ms_options.R b/R/ms_options.R
@@ -57,8 +57,8 @@
 #' }
 #'
 #' @seealso
-#' Vignettes: \href{https://modeloriented.github.io/modelStudio/articles/ms-r-python-examples.html}{\bold{modelStudio - R & Python examples}}
-#' and \href{https://modeloriented.github.io/modelStudio/articles/ms-perks-features.html}{\bold{modelStudio - perks and features}}
+#' Vignettes: \href{https://modelstudio.drwhy.ai/articles/ms-r-python-examples.html}{\bold{modelStudio - R & Python examples}}
+#' and \href{https://modelstudio.drwhy.ai/articles/ms-perks-features.html}{\bold{modelStudio - perks and features}}
 #'
 #' @examples
 #' library("DALEX")

diff --git a/R/ms_update_observations.R b/R/ms_update_observations.R
@@ -15,7 +15,7 @@
 #'  See \href{https://modelstudio.drwhy.ai/articles/ms-perks-features.html#more-calculations-means-more-time}{\bold{vignette}}
 #' @param show_info Verbose a progress on the console. Default is \code{TRUE}.
 #' @param parallel Speed up the computation using \code{parallelMap::parallelMap()}.
-#'  See \href{https://modeloriented.github.io/modelStudio/articles/ms-perks-features.html#parallel-computation}{\bold{vignette}}.
+#'  See \href{https://modelstudio.drwhy.ai/articles/ms-perks-features.html#parallel-computation}{\bold{vignette}}.
 #'  This might interfere with showing progress using \code{show_info}.
 #' @param widget_id Use an explicit element ID for the widget (rather than an automatically generated one).
 #'  Useful e.g. when using \code{modelStudio} with Shiny.
@@ -37,8 +37,8 @@
 #' }
 #'
 #' @seealso
-#' Vignettes: \href{https://modeloriented.github.io/modelStudio/articles/ms-r-python-examples.html}{\bold{modelStudio - R & Python examples}}
-#' and \href{https://modeloriented.github.io/modelStudio/articles/ms-perks-features.html}{\bold{modelStudio - perks and features}}
+#' Vignettes: \href{https://modelstudio.drwhy.ai/articles/ms-r-python-examples.html}{\bold{modelStudio - R & Python examples}}
+#' and \href{https://modelstudio.drwhy.ai/articles/ms-perks-features.html}{\bold{modelStudio - perks and features}}
 #'
 #' @examples
 #' library("DALEX")
@@ -53,7 +53,8 @@
 #'                              y = titanic_imputed$survived)
 #'
 #' # make a studio for the model
-#' ms <- modelStudio(explainer_titanic)
+#' ms <- modelStudio(explainer_titanic,
+#'                   N = 200,  B = 5) # faster example
 #'
 #' \donttest{
 #'

diff --git a/R/ms_update_options.R b/R/ms_update_options.R
@@ -23,8 +23,8 @@
 #' }
 #'
 #' @seealso
-#' Vignettes: \href{https://modeloriented.github.io/modelStudio/articles/ms-r-python-examples.html}{\bold{modelStudio - R & Python examples}}
-#' and \href{https://modeloriented.github.io/modelStudio/articles/ms-perks-features.html}{\bold{modelStudio - perks and features}}
+#' Vignettes: \href{https://modelstudio.drwhy.ai/articles/ms-r-python-examples.html}{\bold{modelStudio - R & Python examples}}
+#' and \href{https://modelstudio.drwhy.ai/articles/ms-perks-features.html}{\bold{modelStudio - perks and features}}
 #'
 #' @examples
 #' library("DALEX")
@@ -39,7 +39,8 @@
 #'                              y = titanic_imputed$survived)
 #'
 #' # make a studio for the model
-#' ms <- modelStudio(explainer_titanic)
+#' ms <- modelStudio(explainer_titanic,
+#'                   N = 200,  B = 5) # faster example
 #'
 #' # update the options
 #' new_ms <- ms_update_options(ms,

diff --git a/README.md b/README.md
@@ -53,11 +53,11 @@ explainer <- explain(model,
 modelStudio(explainer)
 ```
 
-[Save the output](http://modelstudio.drwhy.ai/#save--share) in the form of a HTML file - [**Demo Dashboard**](https://modeloriented.github.io/modelStudio/demo.html).
+[Save the output](http://modelstudio.drwhy.ai/#save--share) in the form of a HTML file - [**Demo Dashboard**](https://modelstudio.drwhy.ai/demo.html).
 
 ![](man/figures/long.gif)
 
-## R & Python Examples [more](http://modelstudio.drwhy.ai/articles/ms-r-python-examples.html)
+## R & Python Examples [more](https://modelstudio.drwhy.ai/articles/ms-r-python-examples.html)
 
 -------------------------------
 
@@ -69,7 +69,7 @@ install.packages("DALEX")
 install.packages("DALEXtra")
 ```
 
-### mlr [dashboard](https://modeloriented.github.io/modelStudio/mlr.html)
+### mlr [dashboard](https://modelstudio.drwhy.ai/mlr.html)
 
 Make a studio for the regression `ranger` model on `apartments` data.
 
@@ -111,7 +111,7 @@ modelStudio(explainer,
 
 </details>
 
-### xgboost [dashboard](https://modeloriented.github.io/modelStudio/xgboost.html)
+### xgboost [dashboard](https://modelstudio.drwhy.ai/xgboost.html)
 
 Make a studio for the classification `xgboost` model on `titanic` data.
 
@@ -173,7 +173,7 @@ Use `pickle` Python module and `reticulate` R package to easily make a studio fo
 install.packages("reticulate")
 ```
 
-### scikit-learn [dashboard](https://modeloriented.github.io/modelStudio/scikitlearn.html)
+### scikit-learn [dashboard](https://modelstudio.drwhy.ai/scikitlearn.html)
 
 Make a studio for the regression `Pipeline SVR` model on `fifa` data.
 
@@ -224,7 +224,7 @@ modelStudio(explainer, B = 5,
 
 </details>
 
-### lightgbm [dashboard](https://modeloriented.github.io/modelStudio/lightgbm.html)
+### lightgbm [dashboard](https://modelstudio.drwhy.ai/lightgbm.html)
 
 Make a studio for the classification `Pipeline LGBMClassifier` model on `titanic` data.
 
@@ -339,9 +339,9 @@ If you use `modelStudio`, please cite our [JOSS article](https://joss.theoj.org/
 
   - Theoretical introduction to the plots: [Explanatory Model Analysis: Explore, Explain and Examine Predictive Models](https://pbiecek.github.io/ema)
 
-  - Vignettes: [modelStudio - perks and features](https://modeloriented.github.io/modelStudio/articles/ms-perks-features.html) and [modelStudio - R & Python examples](https://modeloriented.github.io/modelStudio/articles/ms-r-python-examples.html)  
+  - Vignettes: [modelStudio - perks and features](https://modelstudio.drwhy.ai/articles/ms-perks-features.html) and [modelStudio - R & Python examples](https://modelstudio.drwhy.ai/articles/ms-r-python-examples.html)  
 
-  - Changelog: [NEWS](https://modeloriented.github.io/modelStudio/news/index.html)
+  - Changelog: [NEWS](https://modelstudio.drwhy.ai/news/index.html)
 
   - Conference poster: [MLinPL2019](https://github.com/ModelOriented/modelStudio/blob/master/misc/MLinPL2019_modelStudio_poster.pdf)
 

diff --git a/man/modelStudio.Rd b/man/modelStudio.Rd
diff --git a/man/ms_options.Rd b/man/ms_options.Rd
diff --git a/man/ms_update_observations.Rd b/man/ms_update_observations.Rd
diff --git a/man/ms_update_options.Rd b/man/ms_update_options.Rd
diff --git a/tests/testthat/test_2_0.R b/tests/testthat/test_2_0.R
@@ -40,7 +40,8 @@ testthat::expect_true(!isTRUE(case1$x$options$telemetry))
 case2 <- testthat::expect_silent(
   modelStudio::modelStudio(exp_fifa, data_fifa[1:2,],
                            max_vars = 5, rounding_funtion = signif,
-                           digits = 3, show_info = v))
+                           digits = 3,
+                           N = 5, B = 2, show_info = v))
 testthat::expect_true(
   all(c("mse:", "rmse:", "r2:", "mad:") %in%
         strsplit(case2$x$options$measure_text, split=" ")[[1]]))

diff --git a/tests/testthat/test_modelStudio.R b/tests/testthat/test_modelStudio.R
@@ -2,71 +2,76 @@ context("Check modelStudio() function")
 
 source("test_objects.R")
 
+N = 10
+B = 2
+
 ms1 <- testthat::expect_silent(modelStudio::modelStudio(explain_glm,
                                                         new_observation = titanic_test[1,-9],
                                                         show_info = v))
 
 ms4 <- testthat::expect_silent(modelStudio::modelStudio(explain_glm_numerical,
                                                         new_observation = titanic_test[1:2, c(2,6,7,8)],
-                                                        N = 50, B = 10,
+                                                        N = N, B = B,
                                                         show_info = v))
 
 ms5 <- testthat::expect_silent(modelStudio::modelStudio(explain_glm_not_numerical,
                                                         new_observation = titanic_test[1:2, c(1,3,4,5)],
-                                                        N = 50, B = 10,
+                                                        N = N, B = B,
                                                         show_info = v))
 
 ms6 <- testthat::expect_silent(modelStudio::modelStudio(explain_model_small,
                                                         new_observation = titanic_test[1:2, c(1,2)],
-                                                        N = 50, B = 10,
+                                                        N = N, B = B,
                                                         show_info = v))
 
 ms_readme <-  testthat::expect_silent(modelStudio::modelStudio(explain_titanic_glm,
                                                                new_observations,
-                                                               facet_dim = c(2,2), N = 200, B = 20, time = 0,
+                                                               facet_dim = c(2,2),
+                                                               N = N, B = B, time = 0,
                                                                show_info = v))
 
 ms_rf_apartments <- testthat::expect_silent(modelStudio::modelStudio(explain_rf,
                                                                      new_observation = apartments[1:2,-1],
-                                                                     N = 50, B = 10, facet_dim = c(3,3),
+                                                                     N = N, B = B, facet_dim = c(3,3),
                                                                      time = 50, max_features = 4,
                                                                      show_info = v))
 
 both_without_target <- testthat::expect_silent(modelStudio::modelStudio(explain_both_without_target,
                                                                         new_observation = nx,
-                                                                        N = 10,
-                                                                        B = 2,
+                                                                        N = N,
+                                                                        B = B,
                                                                         show_info = v))
 
 both_full <- testthat::expect_silent(modelStudio::modelStudio(explain_both_full,
                                                               new_observation = nz,
-                                                              N = 10,
-                                                              B = 2,
+                                                              N = N,
+                                                              B = B,
                                                               show_info = v))
 
 obs_without_target_data_full <- testthat::expect_silent(modelStudio::modelStudio(explain_obs_without_target_data_full,
                                                                                  new_observation = nx,
-                                                                                 N = 10,
-                                                                                 B = 2,
+                                                                                 N = N,
+                                                                                 B = B,
                                                                                  show_info = v))
 
 obs_full_data_without_target <- testthat::expect_silent(modelStudio::modelStudio(explain_obs_full_data_without_target,
                                                                                  new_observation = nz,
-                                                                                 N = 10,
-                                                                                 B = 2,
+                                                                                 N = N,
+                                                                                 B = B,
                                                                                  show_info = v))
 
 ms_big <- testthat::expect_silent(modelStudio::modelStudio(explain_artifficial,
-                                                           new_observation = artifficial[1:2,], N = 5, B = 2,
+                                                           new_observation = artifficial[1:2,],
+                                                           N = N, B = B,
                                                            facet_dim = c(3,3),
                                                            show_info = v))
 
 ms_parallel <- modelStudio::modelStudio(explain_glm, new_observation = titanic_test[1:2,-9],
-                                        N = 5, B = 2, parallel = TRUE,
+                                        N = N, B = B, parallel = TRUE,
                                         show_info = v)
 
 ms_parallel_rf <- modelStudio::modelStudio(explain_rf, new_observation = apartments[1:5,-1],
-                                           N = 5, B = 2, parallel = TRUE,
+                                           N = N, B = B, parallel = TRUE,
                                            show_info = v)
 
 # tests
@@ -115,13 +120,18 @@ testthat::test_that("parallel rf", {
 })
 
 testthat::test_that("show_info_and_new_observation_y", {
-  testthat::expect_is(modelStudio::modelStudio(explain_glm), "r2d3")
+  testthat::expect_is(modelStudio::modelStudio(explain_glm,
+                                               titanic_test[1:2,-9],
+                                               titanic_test[1:2, 9],
+                                               N = N, B = B, show_info = TRUE), "r2d3")
 })
 
 testthat::test_that("eda = FALSE", {
-  testthat::expect_is(modelStudio::modelStudio(explain_glm, eda = FALSE), "r2d3")
+  testthat::expect_is(modelStudio::modelStudio(explain_glm, eda = FALSE,
+                                               N = N, B = B, show_info = v), "r2d3")
 })
 
 testthat::test_that("xgboost matrix", {
-  testthat::expect_is(modelStudio::modelStudio(explainer_xgb), "r2d3")
+  testthat::expect_is(modelStudio::modelStudio(explainer_xgb,
+                                               N = N, B = B, show_info = v), "r2d3")
 })