counterfactuals

1.0.0

Counterfactual Explanations

0packages depend

6.3Kdownloads / year

–test coverage

13/13checks pass

Overview

About

Maintained by Susanne DandlFirst published 2023-02-136 releasesCRAN page ↗GitHub ↗

Modular and unified R6-based interface for counterfactual explanation methods. The following methods are currently implemented: Burghmans et al. (2022) doi:10.48550/arXiv.2104.07411, Dandl et al. (2020) doi:10.1007/978-3-030-58112-1_31 and Wexler et al. (2019) doi:10.1109/TVCG.2019.2934619. Optional extensions allow these methods to be applied to a variety of models and use cases. Once generated, the counterfactuals can be analyzed and visualized by provided functionalities. The package is described in detail in Dandl et al. (2025) doi:10.18637/jss.v115.i09.

Install

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

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

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

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("dandls/counterfactuals")

Development version from dandls/counterfactuals. Installs pak first if it is not already available.

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-counterfactuals

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

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-counterfactuals

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-counterfactuals

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

13OK

Slowest check: 3.5 min · r-devel-linux-x86_64-fedora-clang

Code health

None

Tests · ratio 0.00

not tracked

Coverage

100%

Documentation · exports

Dependencies · direct

Check history

OK2026-06-09
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
ERROR2026-06-08
12 OK · 0 NOTE · 0 WARNING · 1 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMEYes · 536 wordsVignettesNopkgdown siteNoNEWSYes · 100% structuredCode of conductNoContributing guideNo

Examples that run: 100%
Documented parameters: not tracked
Return-value docs: 0%
References docs: 63%

Downloads

6.3K

CRAN downloads in the past year

Rank #5,424 · ~17/day · ~526/mo

Releases R versions

Daily download trend is not available in this view yet.

42030 days

1.7K90 days

6.3K1 year

Compare downloads with other packages →

Also on784 r2u24 autocran

Repository

GitHub ↗ dandls/counterfactuals

29Stars

5Forks

3Open issues

0Open PRs

0Releases

473Commits

5Contributors

interpretable-machine-learninglocal-explanationsmodel-agnostic-explanations

License LGPL-3.0 · 473 commits · Last activity 2026-01-14 · +3.6% stars, 30d

Stars over time

2025-07-23 · 232026-07-07 · 29

Repository practices

Upstream repositoryBeta

4 development-tooling and community-health practices detected across 4 families in the upstream repository

Checks run against github.com/dandls/counterfactuals on 2026-07-30.

Continuous integration (1)

GitHub Actions

Docs source (1)

README.Rmd

Lint, format, editor (1)

RStudio project

Coverage (1)

Codecov

How this is detected·Detection ruleset v1 (2026-07-18)

Dependencies

Declared dependencies

31 external dependencies (excludes base and recommended)

Depends (1)

R >= 3.5.0

Imports (8)

R6 checkmate StatMatch iml data.table paradox miesmuschel bbotk

LinkingTo (0)

none

Suggests (25)

gower randomForest GGally trtf testthatMASSR.rsp cowplot covr ggplot2 keras rchallenge gamlss.data partykit mlt variables basefun rmarkdownrpartmlr3 mlr3learners mlr3pipelines tidymodels caret mlr

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

People & History

People (4)

Maintainer (1)

Susanne Dandl

Author, Maintainer

Authors (2)

Susanne Dandl

Author, Maintainer

Andreas Hofheinz

Author

Contributors (2)

Martin Binder

Contributor

Giuseppe Casalicchio

Contributor

Package Timeline

6 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
1.0.0Latest
2026-01-14 · current release · diff ↗
R
R 4.5.0 released · 2025-04-11
0.1.6
2024-10-17 · diff ↗
0.1.5
2024-10-15 · diff ↗
0.1.4
2024-05-14 · diff ↗
R
R 4.4.0 released · 2024-04-24
R
R 4.3.0 released · 2023-04-21
0.1.2
2023-03-23 · diff ↗
0.1.1
2023-02-13
R
R 4.2.0 released · 2022-04-22

Package metadata

First published: 2023-02-13
Total releases: 6 / 3 yrs
License: LGPL-3 OSI
Minimum R: ≥ 3.5.0
Download size: 498 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Report a problem with this page →