documentation

Author: hbaniecki

NEWS.md

@@ -6,7 +6,7 @@
   * `margin_left = NULL` by default and it is adjusted based on the length of variable names 
   * the first plot opened in the dashboard is now `FI` instead of `BD` by default
 * added the `verbose` parameter to `modelStudio()` as an alias to `show_info` [(#101)](https://github.com/ModelOriented/modelStudio/issues/101)
-* add new `ms_merge_observations()` function that merges local explanation of observations from multiple `modelStudio` objects [(#102)](https://github.com/ModelOriented/modelStudio/issues/102)
+* added new `ms_merge_observations()` function that merges local explanation of observations from multiple `modelStudio` objects [(#102)](https://github.com/ModelOriented/modelStudio/issues/102)
 
 # modelStudio 2.1.2
 * fixed an error in `modelStudio()` when data had only one variable [(#99)](https://github.com/ModelOriented/modelStudio/issues/99)

R/ms_merge_observations.R

@@ -25,6 +25,26 @@
 #' library("DALEX")
 #' library("modelStudio")
 #' 
+#' # fit a model
+#' model_happiness <- glm(score ~., data = happiness_train)
+#' 
+#' # create an explainer for the model
+#' explainer_happiness <- explain(model_happiness,
+#'                                data = happiness_test,
+#'                                y = happiness_test$score)
+#' 
+#' # make studios for the model
+#' ms1 <- modelStudio(explainer_happiness,
+#'                    N = 200,  B = 5) # faster example
+#' 
+#' ms2 <- modelStudio(explainer_happiness,
+#'                    new_observation = head(happiness_test, 3),
+#'                    N = 200,  B = 5)
+#' 
+#' # merge 
+#' ms <- ms_merge_observations(ms1, ms2)
+#' ms
+#' 
 #'
 #' @export
 #' @rdname ms_merge_observations