Skip to content

Commit

Permalink
final changes for cran submission version 0.3.1
Browse files Browse the repository at this point in the history
nkoenen committed Nov 26, 2024
1 parent ac13675 commit 8b8c3f7
Showing 7 changed files with 14 additions and 11 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
@@ -15,3 +15,4 @@
^vignettes/figure$
^vignettes/articles$
^codecov\.yml$
^CRAN-SUBMISSION$
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -14,10 +14,10 @@ Description: Interpretation methods for analyzing the behavior and individual
<doi:10.1016/j.ecolmodel.2004.03.013>, layer-wise relevance
propagation ('LRP') described by Bach et al. (2015)
<doi:10.1371/journal.pone.0130140>, deep learning important features
('DeepLIFT') described by Shrikumar et al. (2017) <arXiv:1704.02685>
('DeepLIFT') described by Shrikumar et al. (2017) <doi:10.48550/arXiv.1704.02685>
and gradient-based methods like 'SmoothGrad' described by Smilkov et
al. (2017) <arXiv:1706.03825>, 'Gradient x Input' described by
Baehrens et al. (2009) <arXiv:0912.1128> or 'Vanilla Gradient'.
al. (2017) <doi:10.48550/arXiv.1706.03825>, 'Gradient x Input'
or 'Vanilla Gradient'.
Details can be found in the accompanying scientific paper: Koenen & Wright
(2024, Journal of Statistical Software, <doi:10.18637/jss.v111.i08>).
License: MIT + file LICENSE
4 changes: 2 additions & 2 deletions R/innsight.R
Original file line number Diff line number Diff line change
@@ -46,12 +46,12 @@
#' innsight" by Koenen & Wright (2024), published in the
#' *Journal of Statistical Software*. For a detailed explanation of the
#' methods and use cases, please refer to the publication
#' (doi: [10.18637/jss.v111.i08](https://doi.org/10.18637/jss.v111.i08)).
#' (doi: \doi{10.18637/jss.v111.i08}).
#'
#' @references
#' Koenen, N., & Wright, M. N. (2024). Interpreting Deep Neural Networks with
#' the Package innsight. Journal of Statistical Software, 111(8), 1-52. doi:
#' [10.18637/jss.v111.i08](https://doi.org/10.18637/jss.v111.i08)
#' \doi{10.18637/jss.v111.i08}
#'
"_PACKAGE"

3 changes: 2 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
@@ -29,6 +29,7 @@ knitr::opts_chunk$set(
* [Usage](#usage)
* [Examples](#examples)
* [Contributing and future work](#contributing-and-future-work)
* [Citation](#citation)
* [Funding](#funding)

## Introduction
@@ -82,7 +83,7 @@ for details).

The package can be installed directly from CRAN and the development version
from GitHub with the following commands (successful
installation of [`devtools`](https://www.r-project.org/nosvn/pandoc/devtools.html) is required)
installation of [`devtools`](https://devtools.r-lib.org/) is required)

```{r, eval = FALSE}
# Stable version
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -21,6 +21,7 @@ coverage](https://codecov.io/gh/bips-hb/innsight/branch/master/graph/badge.svg)]
- [Usage](#usage)
- [Examples](#examples)
- [Contributing and future work](#contributing-and-future-work)
- [Citation](#citation)
- [Funding](#funding)

## Introduction
@@ -80,8 +81,7 @@ for details).

The package can be installed directly from CRAN and the development
version from GitHub with the following commands (successful installation
of [`devtools`](https://www.r-project.org/nosvn/pandoc/devtools.html) is
required)
of [`devtools`](https://devtools.r-lib.org/) is required)

``` r
# Stable version
3 changes: 2 additions & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
@@ -42,4 +42,5 @@ and disabled their execution on CRAN.

#### R CMD check results

There were no errors, warnings or notes.
There were no errors, warnings or notes (only the already mentioned note on
the DOI).
4 changes: 2 additions & 2 deletions man/innsight-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8b8c3f7

Please sign in to comment.