Skip to content

Commit

Permalink
Final cran comments. Ready for submission upon merge to master
Browse files Browse the repository at this point in the history
  • Loading branch information
martinju committed Dec 29, 2024
1 parent eb902f4 commit de9b8c7
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 16 deletions.
25 changes: 11 additions & 14 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# shapr 1.0.1
# shapr 1.0.1 (Major release)

* Complete rewrite of the package compared to the previous CRAN release. We moved from two main user functions
`shapr()` and `explain()` to a single function `explain()` that includes both.
Thus, this change breaks essentially all existing code that uses the previous version of the package.
* A comprehensive list of changes and new functionality can be found in the NEWS.md file.
* We deem the package fully mature at this stage, and therefore release it as a 1.0.0 version.

* We deem the package fully mature at this stage, and therefore release it as a stable, major version.

## Test environments

The majority of our tests rely uses snapshots. These tests are run locally and with GHA.
The majority of our tests rely uses snapshots to check results reproducibility.
These tests are run locally and remotely with GHA (see below) without errors.
The win-builder and R-hub tests are run without snapshots tests (to replicate CRAN testing)

* GitHub Actions (ubuntu-latest), R-version: devel, release, oldrel-1, oldrel-2
* GitHub Actions (windows-latest), R-version: release
* GitHub Actions (macOS-latest), R-version: release
* GHA (ubuntu-latest), R-version: devel, release, oldrel-1, oldrel-2
* GHA (windows-latest), R-version: release
* GHA (macOS-latest), R-version: release
* win-builder, R-versions: devel, release, oldrelease
* R-hub (ubuntu-latest): R-version: devel
* R-hub (macos-13): R-version: devel
Expand Down Expand Up @@ -51,7 +51,7 @@ explain 10.33 0.44 10.77
doc 4.4Mb
libs 1.3Mb

> The package is growing in size, uses more complied code, and the documentation is comprehensive
> The package is growing in size, uses more complied code, and the documentation is comprehensive.

## Downstream dependencies
Expand All @@ -74,9 +74,6 @@ There has been no reaction from the maintainer.
### shapviz

* Nov 15th 2024 I submitted a PR fixing the issue: https://github.com/ModelOriented/shapviz/pull/162
The PR was merged to the GitHub version on Nov 16th 2024. The CRAN version has naturally not been updated yet.
I will notify the maintainer when the new version of `shapr` is released on CRAN.




The PR was merged to the GitHub version of `shapviz` on Nov 16th 2024.
The CRAN version has naturally not been updated yet.
I will notify the maintainer of `shapvix` when the new version of `shapr` is released on CRAN.
2 changes: 1 addition & 1 deletion vignettes/general_usage.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ efficient approximation to Shapley values in higher dimensions, but it
assumes independent features. @aas2019explaining extends the Kernel SHAP
method to handle dependent features, resulting in more accurate
approximations to the true Shapley values. See the
[paper](https://www.sciencedirect.com/science/article/pii/S0004370221000539/pdfft?md5=c3e4b95131ed944dc23b05a6170dbaee&pid=1-s2.0-S0004370221000539-main.pdf)
[paper](https://martinjullum.com/publication/aas-2021-explaining/aas-2021-explaining.pdf)
(@aas2019explaining) for further details.


Expand Down
2 changes: 1 addition & 1 deletion vignettes/general_usage.Rmd.orig
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ efficient approximation to Shapley values in higher dimensions, but it
assumes independent features. @aas2019explaining extends the Kernel SHAP
method to handle dependent features, resulting in more accurate
approximations to the true Shapley values. See the
[paper](https://www.sciencedirect.com/science/article/pii/S0004370221000539/pdfft?md5=c3e4b95131ed944dc23b05a6170dbaee&pid=1-s2.0-S0004370221000539-main.pdf)
[paper](https://martinjullum.com/publication/aas-2021-explaining/aas-2021-explaining.pdf)
(@aas2019explaining) for further details.


Expand Down

0 comments on commit de9b8c7

Please sign in to comment.