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✨
card.svg |card.png
SHAPforxgboost/json (API)
NEWS

# 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:

Conda:

9.76 score 135 stars 2 packages 401 scripts 3.9k downloads 3 mentions 13 exports 119 dependencies

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

TargetResultTimeFilesSyslog
linux-devel-x86_64OK203
source / vignettesOK266
linux-release-x86_64OK234
macos-release-arm64OK185
macos-oldrel-arm64OK192
windows-develOK131
windows-releaseOK120
windows-oldrelOK154
wasm-releaseOK141

Exports:scatter.plot.diagonalscatter.plot.simpleshap.importanceshap.plot.dependenceshap.plot.force_plotshap.plot.force_plot_bygroupshap.plot.summaryshap.plot.summary.wrap1shap.plot.summary.wrap2shap.prepshap.prep.interactionshap.prep.stack.datashap.values

Dependencies:abindbackportsbase64encBBmiscbootbroombslibcachemcarcarDatacheckmateclicolorspacecolourpickercommonmarkcorrplotcowplotcpp11data.tableDerivdigestdoBydplyrevaluatefarverfastmapfontawesomeforecastFormulafracdifffsgenericsggExtraggforceggplot2ggpubrggrepelggsciggsignifgluegridExtragtablehighrhtmltoolshtmlwidgetshttpuvisobandjquerylibjsonliteknitrlabelinglaterlatticelifecyclelme4lmtestmagrittrMASSMatrixMatrixModelsmemoisemgcvmicrobenchmarkmimeminiUIminqamodelrnlmenloptrnnetnumDerivotelpbkrtestpillarpkgconfigpolyclippolynompromisespurrrquantregR6rappdirsrbibutilsRColorBrewerRcppRcppArmadilloRcppEigenRdpackreformulasrlangrmarkdownrstatixS7sassscalesshinyshinyjssourcetoolsSparseMstringistringrsurvivalsystemfontstibbletidyrtidyselecttimeDatetinytextweenrurcautf8vctrsviridisLitewithrxfunxgboostxtableyamlzoo

Basic Workflow

Rendered frombasic_workflow.Rmdusingknitr::rmarkdownon May 12 2026.

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

Readme and manuals

Help Manual

Help pageTopics
Terra satellite data (X,Y) for running the xgboost model .dataXY_df
Modify labels for features under plottinglabel.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 featureplot.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 plotsshap.plot.dependence
Create SHAP force plot (stacked bar chart)shap.plot.force_plot
Create faceted SHAP force plots by clustershap.plot.force_plot_bygroup
SHAP summary plot using long-format SHAP valuesshap.plot.summary
A wrapped function to make summary plot from model object and predictorsshap.plot.summary.wrap1
A wrapped function to make summary plot from given SHAP values matrixshap.plot.summary.wrap2
Prepare SHAP values into long format for plottingshap.prep
Prepare the interaction SHAP values from predict.xgb.Boostershap.prep.interaction
Prepare data for SHAP force plot (stacked bar chart)shap.prep.stack.data
Get SHAP scores from a trained XGBoost or LightGBM modelshap.values