Package: SHAPforxgboost 0.2.0

SHAPforxgboost: SHAP Plots for 'XGBoost'

Aid in visual data investigations using SHAP (SHapley Additive exPlanation) visualization plots for 'XGBoost' and 'LightGBM'. It provides summary plot, dependence plot, interaction plot, and force plot and relies on the SHAP implementation provided by 'XGBoost' and 'LightGBM'.

Authors:Yang Liu [aut, cre], Allan Just [aut, ctb], Michael Mayer [ctb]

SHAPforxgboost_0.2.0.tar.gz
SHAPforxgboost_0.2.0.zip(r-4.7)SHAPforxgboost_0.2.0.zip(r-4.6)SHAPforxgboost_0.2.0.zip(r-4.5)
SHAPforxgboost_0.2.0.tgz(r-4.6-any)SHAPforxgboost_0.2.0.tgz(r-4.5-any)
SHAPforxgboost_0.2.0.tar.gz(r-4.7-any)SHAPforxgboost_0.2.0.tar.gz(r-4.6-any)
SHAPforxgboost_0.2.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
SHAPforxgboost/json (API)

# Install 'SHAPforxgboost' in R:

install.packages('SHAPforxgboost', repos = c('https://liuyanguu.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/liuyanguu/shapforxgboost/issues

Datasets:

dataXY_df - Terra satellite data (X,Y) for running the xgboost model .
labels_within_package - Labels_within_package: Some labels package auther defined to make his plot, mainly serve the paper publication.
shap_int_iris - The interaction effect SHAP values example using iris dataset.
shap_long_iris - The long-format SHAP values example using iris dataset.
shap_score - SHAP values example from dataXY_df .
shap_values_iris - SHAP values example using iris dataset.

On CRAN:

9.73 score 136 stars 2 packages 449 scripts 3.3k downloads 3 mentions 13 exports 119 dependencies

Last updated from:02363396a6. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	195
source / vignettes	OK	210
linux-release-x86_64	OK	199
macos-release-arm64	OK	515
macos-oldrel-arm64	OK	216
windows-devel	OK	130
windows-release	OK	127
windows-oldrel	OK	128
wasm-release	OK	135

Exports:scatter.plot.diagonal scatter.plot.simple shap.importance shap.plot.dependence shap.plot.force_plot shap.plot.force_plot_bygroup shap.plot.summary shap.plot.summary.wrap1 shap.plot.summary.wrap2 shap.prep shap.prep.interaction shap.prep.stack.data shap.values

Dependencies:abind backports base64enc BBmisc boot broom bslib cachem car carData checkmate cli colorspace colourpicker commonmark corrplot cowplot cpp11 data.table Deriv digest doBy dplyr evaluate farver fastmap fontawesome forecast Formula fracdiff fs generics ggExtra ggforce ggplot2 ggpubr ggrepel ggsci ggsignif glue gridExtra gtable highr htmltools htmlwidgets httpuv isoband jquerylib jsonlite knitr labeling later lattice lifecycle lme4 lmtest magrittr MASS Matrix MatrixModels memoise mgcv microbenchmark mime miniUI minqa modelr nlme nloptr nnet numDeriv otel pbkrtest pillar pkgconfig polyclip polynom promises purrr quantreg R6 rappdirs rbibutils RColorBrewer Rcpp RcppArmadillo RcppEigen Rdpack reformulas rlang rmarkdown rstatix S7 sass scales shiny shinyjs sourcetools SparseM stringi stringr survival systemfonts tibble tidyr tidyselect timeDate tinytex tweenr urca utf8 vctrs viridisLite withr xfun xgboost xtable yaml zoo

Basic Workflow

Introduction | Training the model | SHAP analysis | References

Rendered frombasic_workflow.Rmdusingknitr::rmarkdown

Last update: 2022-05-18
Started: 2021-03-26

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Terra satellite data (X,Y) for running the xgboost model .	dataXY_df
Modify labels for features under plotting	label.feature
labels_within_package: Some labels package auther defined to make his plot, mainly serve the paper publication.	labels_within_package
new_labels: a place holder default to NULL.	new_labels
Internal-function to revise axis label for each feature	plot.label
Make customized scatter plot with diagonal line and R2 printed.	scatter.plot.diagonal
Simple scatter plot, adding marginal histogram by default.	scatter.plot.simple
The interaction effect SHAP values example using iris dataset.	shap_int_iris
The long-format SHAP values example using iris dataset.	shap_long_iris
SHAP values example from dataXY_df .	shap_score
SHAP values example using iris dataset.	shap_values_iris
Variable importance as measured by mean absolute SHAP value.	shap.importance
SHAP dependence and interaction plots	shap.plot.dependence
Create SHAP force plot (stacked bar chart)	shap.plot.force_plot
Create faceted SHAP force plots by cluster	shap.plot.force_plot_bygroup
SHAP summary plot using long-format SHAP values	shap.plot.summary
A wrapped function to make summary plot from model object and predictors	shap.plot.summary.wrap1
A wrapped function to make summary plot from given SHAP values matrix	shap.plot.summary.wrap2
Prepare SHAP values into long format for plotting	shap.prep
Prepare the interaction SHAP values from predict.xgb.Booster	shap.prep.interaction
Prepare data for SHAP force plot (stacked bar chart)	shap.prep.stack.data
Get SHAP scores from a trained XGBoost or LightGBM model	shap.values