update documentation

Author: hbaniecki

DESCRIPTION

@@ -10,9 +10,9 @@ Authors@R:
 Description: Automate the explanatory analysis of machine learning predictive models.
     Generate advanced interactive and animated model explanations in the form of
     a serverless HTML site with only one line of code. This tool is model agnostic,
-    therefore compatibile with most of the black box predictive models and frameworks.
+    therefore compatible with most of the black box predictive models and frameworks.
     The main function computes various (instance and dataset level) model explanations
-    and produces an interactive, customisable dashboard made with 'D3.js'. It consists
+    and produces an interactive, customizable dashboard made with 'D3.js'. It consists
     of multiple panels for plots with their short descriptions. Easily save and share 
     the dashboard with others. Tools for model exploration unite with tools for EDA 
     (Exploratory Data Analysis) to give a broad overview of the model behavior.

NEWS.md

@@ -1,6 +1,6 @@
 # modelStudio 1.0.2 (development)
 * fix `FD` plot on matrix-like data 
-* center `modelStudio` position  
+* center `modelStudio` position in HTML
 * `modelStudio` now renders properly from `.Rmd` to `.html`
 
 # modelStudio 1.0.1

R/modelStudio.R

@@ -2,7 +2,7 @@
 #'
 #' @description
 #' This function computes various (instance and dataset level) model explanations and produces an interactive,
-#' customisable dashboard made with D3.js. It consists of multiple panels for plots with their short descriptions.
+#' customizable dashboard made with D3.js. It consists of multiple panels for plots with their short descriptions.
 #' Easily save and share the dashboard with others. Tools for model exploration unite with tools for EDA
 #' (Exploratory Data Analysis) to give a broad overview of the model behavior.
 #'

README.md

@@ -8,7 +8,7 @@
 
 ## Overview
 
-The `modelStudio` package **automates the Explanatory Analysis of Machine Learning predictive models**. Generate advanced interactive and animated model explanations in the form of a **serverless HTML site** with only one line of code. This tool is model agnostic, therefore compatibile with most of the black box predictive models and frameworks (e.g. `mlr/mlr3`, `xgboost`, `caret`, `h2o`, `scikit-learn`, `lightGBM`, `tensorflow/keras`).
+The `modelStudio` package **automates the Explanatory Analysis of Machine Learning predictive models**. Generate advanced interactive and animated model explanations in the form of a **serverless HTML site** with only one line of code. This tool is model agnostic, therefore compatible with most of the black box predictive models and frameworks (e.g. `mlr/mlr3`, `xgboost`, `caret`, `h2o`, `scikit-learn`, `lightGBM`, `tensorflow/keras`).
 
 The main `modelStudio()` function computes various (instance and dataset level) model explanations and produces an **interactive, customisable dashboard made with D3.js**. It consists of multiple panels for plots with their short descriptions. Easily **save and share** the dashboard with others. Tools for model exploration unite with tools for EDA (Exploratory Data Analysis) to give a broad overview of the model behavior.
 
@@ -236,6 +236,9 @@ explainer <- py_load_object('explainer_titanic.pickle')
 predict_function <- function(model, data) {
   if ("predict_proba" %in% names(model)) {
     pred <- model$predict_proba(data)
+    if (ncol(pred) == 2) {
+      pred <- pred[,2]
+    }
   } else {
     pred <- model$predict(data)
   }

inst/WORDLIST

@@ -23,3 +23,11 @@ serverless
 SHAP
 suppressWarnings
 updateModelStudio
+xgboost
+tensorflow
+Shapley
+cran
+CRAN
+MLPCLassifier
+keras
+lightGBM