R Observatory: Metrics for xaiHydro version 0.1.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

xaiHydro

0.1.0Package record

Explainable AI Tools for Hydro-Climate Modelling

0packages depend

407downloads / year

1.5%test coverage

13/13flavors OK

Overview

About

Maintained by Sadikul IslamCRAN page ↗

Provides a unified workflow for applying Explainable Artificial Intelligence (XAI) methods to hydro-climate predictive models. Functions implement a permutation-based Monte Carlo SHAP estimator (Strumbelj and Kononenko (2014) doi:10.1007/s10115-013-0679-x; Lundberg and Lee (2017) doi:10.48550/arXiv.1705.07874), a self-contained locally weighted linear surrogate LIME (Ribeiro et al. (2016) doi:10.1145/2939672.2939778), and Partial Dependence Plots with Accumulated Local Effects (Friedman (2001) doi:10.1214/aos/1013203451; Apley and Zhu (2020) doi:10.1111/rssb.12377) with hydrology-specific visualisations and interpretation utilities. Supports any model object compatible with the 'DALEX' explainer interface (Biecek (2018) doi:10.18637/jss.v097.i01), including random forests, gradient boosting, and neural networks trained on streamflow, drought indices, flood risk, or evapotranspiration data. Hydrology-standard performance metrics Nash-Sutcliffe Efficiency (NSE, Nash and Sutcliffe (1970) doi:10.1016/0022-1694(70)90255-6) and Kling-Gupta Efficiency (KGE, Gupta et al. (2009) doi:10.1016/j.jhydrol.2009.08.003) are computed alongside standard regression metrics. Designed to accompany the book chapter: Islam, S., Dheeraj, A., Ali, S., Kaushal, R. and Venkatesh, G. (2026). Explainable Artificial Intelligence for Hydro-Climatic Modelling: Methods, Applications, and Implementation Using the xaiHydro R Package. In Chandniha, S. K. et al. (Eds.), Hydro-Climate Analytics: Remote Sensing, AI and Geospatial Modelling. Springer.

Changes in 0.1.0

Authors

**Sadikul Islam** [aut, cre] — ICAR-IISWC Dehradun; sadikul.islamiasri@gmail.com
**Shakir Ali** [aut] — ICAR-IISWC Dehradun
**Rajesh Kaushal** [aut] — ICAR-IISWC Dehradun

Changes in this release

Authors updated

Added Shakir Ali as co-author (aut) in DESCRIPTION, all R file headers, xaiHydro-package.R, .onAttach() message, and README.md.
All three authors now listed throughout the package.

Forbidden files removed (CRAN compliance)

Deleted LICENSE, LICENSE.md (GPL-3 needs no external file).
Deleted .Rhistory, .Rproj.user/ (RStudio user files must not be shipped).

Show all changes in 0.1.0Hide the rest of the changes in 0.1.0

No GitHub URLs in DESCRIPTION or README.

Book chapter citation updated

Description field and package-level documentation now reference the full five-author book chapter: Islam, Dheeraj, Ali, Kaushal & Venkatesh (2026), Springer Hydro-Climate Analytics volume.

New reference added

Zounemat-Kermani & Kheimi (2026) systematic review (180 studies, 9 domains, Water Resources Management) added to xaiHydro-package.R @references.

Bug fixes carried forward from development

hydro_importance(): loss_function default changed from character "rmse" to DALEX::loss_root_mean_square (DALEX >= 2.4 API change).
hydro_residuals(): recomputes predictions directly from explainer$y and explainer$predict_function to avoid DALEX version-dependent column names.
hydro_lime(): .lime_r2() helper safely extracts R-squared across iml versions (0.10 and 0.11+) returning NA_real_ when unavailable.
plot_breakdown_hydro(): make.unique() prevents duplicate factor level error.
.Rbuildignore updated to exclude .Rhistory and .Rproj.user.

From NEWS.md in the release

Install

R (CRAN)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("xaiHydro", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-xaihydro

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-xaiHydro

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-xaiHydro

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

Slowest check: 1.4 min · r-oldrel-windows-x86_64

Status changes

OK13 OKNow
OK6 OK2026-09-25

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 0.1.0

READMEYes · 422 wordsVignettesYes · 2 · dynamicNEWSYes · 67% structured · mentions 0.1.0Citation fileNoWebsitenot declared in DESCRIPTION

Description cites a JSS article

Help pages: 17 (1 internal)includes a package overview page
Examples that run: 19%3 run in a plain check · 13 only when donttest examples are enabled (R CMD check --as-cran)
Exported functions with examples: 100%
Documented parameters: 99%
Return-value docs: 100%
Help pages citing references: 100%

Vignettes (2)

How these are measured

Downloads

407

CRAN downloads in the past year

Rank #25,129 · ~1/day · ~34/mo

Releases R versions

Daily download trend is not available in this view yet.

40730 days

40790 days

4071 year

Compare downloads with other packages →

Also on5 r2u1 autocran

How downloads are counted

Dependencies

Declared dependencies

13 external dependencies (excludes base and recommended)

Installing xaiHydro adds 44 packages (17 with compiled code, 38 MB of source tarballs). Heaviest: stringi 11 MB, ggplot2 6.0 MB, patchwork 3.2 MB.

Depends (1)

R >= 4.1.0

Imports (7)

DALEX ggplot2 dplyr tidyr patchwork cli rlang (>= 1.1.0)

LinkingTo (0)

none

Suggests (6)

randomForest xgboost ranger (>= 0.16.0)testthat knitr rmarkdown (>= 2.25)

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

People & History

People (3)

Sadikul Islam

Author, Maintainer since 0.1.0 (2026)

Shakir Ali

Author

Rajesh Kaushal

Author

Releases (1)

0.1.0Latest
record
2026-09-24 · current release
R
R 4.6.0 released · 2026-04-24

Package metadata

First published: 2026-09-24
Total releases: 1 / 1 yrs
License: GPL-3 OSI
Minimum R: ≥ 4.1.0
Download size: 73 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("xaiHydro")

Format

Islam, S., Ali, S., & Kaushal, R. (2026). xaiHydro: Explainable AI Tools for Hydro-Climate Modelling (Version 0.1.0) [Computer software]. https://doi.org/10.32614/CRAN.package.xaiHydro

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for xaiHydro version 0.1.0 [Data set]. HJJB, LLC. Data release v2026-10-23. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-23, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →