Science Score: 33.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
✓Academic publication links
Links to: arxiv.org -
✓Committers with academic emails
1 of 6 committers (16.7%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.3%) to scientific vocabulary
Keywords
Repository
Model Agnostics breakDown plots
Basic Info
- Host: GitHub
- Owner: pbiecek
- Language: R
- Default Branch: master
- Homepage: https://pbiecek.github.io/breakDown/
- Size: 20.2 MB
Statistics
- Stars: 103
- Watchers: 11
- Forks: 16
- Open Issues: 7
- Releases: 0
Topics
Metadata Files
README.md
Break Down: Model Agnostic Explainers for Individual Predictions
The breakDown package is a model agnostic tool for decomposition of predictions from black boxes.
Break Down Table shows contributions of every variable to a final prediction.
Break Down Plot presents variable contributions in a concise graphical way.
This package works for binary classifiers and general regression models.
Find lots of R examples at breakDown website: https://pbiecek.github.io/breakDown/
Interested in the methodology? Find the math behind breakDown and live at: https://arxiv.org/abs/1804.01955
Looking for the python version of Break Down? Find it here: https://github.com/bondyra/pyBreakDown
New generation of the Break-Down algorithm is implemented in the iBreakDown package https://github.com/ModelOriented/iBreakDown. All new features will be added to the iBreakDown.
Installation
Install from CRAN
install.packages("breakDown")
Install from GitHub
devtools::install_github("pbiecek/breakDown")
Cheatsheets

Example for lm model
Get data with archivist
- broken object:
archivist::aread("pbiecek/breakDown/arepo/81c5be568d4db2ec795dedcb5d7d6599") - the plot:
archivist::aread("pbiecek/breakDown/arepo/7b40949a0fdf9c22780454581d4b556e")
The R code
```{r} library(breakDown) url <- 'https://archive.ics.uci.edu/ml/machine-learning-databases/wine-quality/winequality-white.csv' wine <- read.table(url, header = T, sep=";") head(wine, 3)
fixed.acidity volatile.acidity citric.acid residual.sugar chlorides free.sulfur.dioxide total.sulfur.dioxide density pH
1 7.0 0.27 0.36 20.7 0.045 45 170 1.0010 3.00
2 6.3 0.30 0.34 1.6 0.049 14 132 0.9940 3.30
3 8.1 0.28 0.40 6.9 0.050 30 97 0.9951 3.26
sulphates alcohol quality
1 0.45 8.8 6
2 0.49 9.5 6
3 0.44 10.1 6
model <- lm(quality ~ fixed.acidity + volatile.acidity + citric.acid + residual.sugar + chlorides + free.sulfur.dioxide + total.sulfur.dioxide + density + pH + sulphates + alcohol, data = wine) newobservation <- wine[1,] br <- broken(model, newobservation) br
contribution
(Intercept) 5.90000
residual.sugar = 20.7 1.20000
density = 1.001 -1.00000
alcohol = 8.8 -0.33000
pH = 3 -0.13000
free.sulfur.dioxide = 45 0.03600
sulphates = 0.45 -0.02500
volatile.acidity = 0.27 0.01500
fixed.acidity = 7 0.00950
total.sulfur.dioxide = 170 -0.00900
citric.acid = 0.36 0.00057
chlorides = 0.045 0.00019
final_prognosis 5.60000
plot(br)
```

Owner
- Name: Przemysław Biecek
- Login: pbiecek
- Kind: user
- Location: Warsaw, Poland
- Company: @ModelOriented @MI2DataLab @MI2-Education @BetaAndBit @mim-uw University of Warsaw
- Website: http://www.linkedin.com/in/pbiecek
- Twitter: PrzeBiec
- Repositories: 151
- Profile: https://github.com/pbiecek
I just like to make things. https://mi2.ai/
GitHub Events
Total
- Watch event: 2
Last Year
- Watch event: 2
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Przemysław Biecek | p****k@g****m | 85 |
| Aleksandra Grudziąż | o****a@g****m | 4 |
| Joseph Larmarange | j****h@l****t | 2 |
| Teun van den Brand | t****d@g****m | 1 |
| Henning | h****y@p****g | 1 |
| Mateusz Staniak | m****k@m****l | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 7 months ago
All Time
- Total issues: 26
- Total pull requests: 7
- Average time to close issues: 8 days
- Average time to close pull requests: 18 days
- Total issue authors: 17
- Total pull request authors: 5
- Average comments per issue: 1.42
- Average comments per pull request: 1.29
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- pbiecek (8)
- holgerbrandl (2)
- DemGrg (2)
- Margarida-F (1)
- Nadu123 (1)
- harell (1)
- alexsuarez94 (1)
- alexhallam (1)
- sfd99 (1)
- mmalek55 (1)
- Abuamany (1)
- AleksandraDabrowska (1)
- amirva (1)
- mstaniak (1)
- ZellW (1)
Pull Request Authors
- AleksandraDabrowska (3)
- teunbrand (2)
- mstaniak (1)
- larmarange (1)
- henningsway (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- cran 549 last-month
- Total docker downloads: 989
-
Total dependent packages: 6
(may contain duplicates) -
Total dependent repositories: 7
(may contain duplicates) - Total versions: 12
- Total maintainers: 1
cran.r-project.org: breakDown
Model Agnostic Explainers for Individual Predictions
- Homepage: https://pbiecek.github.io/breakDown/
- Documentation: http://cran.r-project.org/web/packages/breakDown/breakDown.pdf
- License: GPL-2
-
Latest release: 0.2.2
published almost 2 years ago
Rankings
Maintainers (1)
conda-forge.org: r-breakdown
- Homepage: https://pbiecek.github.io/breakDown/
- License: GPL-2.0-only
-
Latest release: 0.2.1
published about 5 years ago
Rankings
Dependencies
- R >= 3.0 depends
- ggplot2 * imports
- DALEX * suggests
- caret * suggests
- e1071 * suggests
- kernlab * suggests
- knitr * suggests
- randomForest * suggests
- ranger * suggests
- rmarkdown * suggests
- testthat * suggests
- xgboost * suggests
