Skip to content

Commit

Permalink
updated cran comments
Browse files Browse the repository at this point in the history
  • Loading branch information
mtwesley committed Nov 27, 2024
1 parent a402398 commit 659bc61
Showing 1 changed file with 49 additions and 17 deletions.
66 changes: 49 additions & 17 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,62 @@
## R Package Submission: greta.censored 0.1.0
## Resubmission: greta.censored 0.1.0

### Summary

This is the initial release of the `greta.censored` package, which provides additional censored distributions for use with Greta, a probabilistic programming framework for Bayesian modeling.
This is the initial submission of the `greta.censored` package, which provides censored distributions for use with Greta, a probabilistic programming framework for Bayesian modeling.

### Changes Made in Response to CRAN Feedback

1. **Installation Errors**
- Added checks to ensure that `tensorflow` and `tensorflow_probability` are available before use. If unavailable, the package now issues a warning and gracefully fails instead of raising an error.
- Tested installation in environments without TensorFlow to confirm graceful degradation.

2. **VignetteBuilder Field**
- Prebuilt vignettes have been added to the package to address the NOTE regarding the `VignetteBuilder` field in `DESCRIPTION`.

3. **Invalid URLs**
- Updated the Codecov URL in `README.md` to `https://app.codecov.io/gh/mtwesley/greta.censored?branch=main`.
- Fixed or removed the broken Code of Conduct URL. If unavailable, a relative link to `CODE_OF_CONDUCT.md` is now used.

4. **Title Field in DESCRIPTION**
- Updated the Title field in `DESCRIPTION` to use title case: `"Censored Distributions for Greta"`.

5. **Spelling Issues**
- Confirmed that flagged terms such as `Weibull` and `greta` are intentional and correct. Added these to the `.aspell` dictionary for future checks.

6. **Namespace and Dependencies**
- Explicitly declared all necessary imports from `reticulate` in the `NAMESPACE` file.
- Removed unused dependencies (`cli` and `rlang`) from the `DESCRIPTION` file.

7. **Global Variable**
- Declared `rate` as a global variable to address the NOTE regarding its undefined use in the `normal_censored` function.

### Package Checks

- The package has been checked using `R CMD check` on the following platforms:
- Local machine (macOS 12.0.1, R 4.1.2)
- GitHub Actions (Ubuntu 18.04, macOS-latest, Windows-latest)
- R-hub (Windows Server 2022, Ubuntu Linux 20.04, Fedora Linux 34)
The package has been checked using `R CMD check` with `--as-cran` on the following platforms:

All checks passed without errors or warnings.
1. **Local Environment**
- macOS 15.0, R 4.3.2
- Ubuntu 22.04 (Docker), R 4.3.2
- Windows 10, R-devel

### Test Coverage
2. **Continuous Integration**
- GitHub Actions:
- Ubuntu-latest
- macOS-latest
- Windows-latest

- The package includes comprehensive unit tests for all functions.
- Test coverage is reported using `covr` and is available on Codecov.
3. **R-hub**
- Windows Server 2022, R-devel
- Ubuntu Linux 20.04, R-devel
- Fedora Linux 34, R-devel

### Dependencies
All checks passed without errors or warnings. Notes have been addressed as described above.

### Test Coverage

- The package depends on the following CRAN packages:
- `greta (>= 0.4.2)`
- `R (>= 3.1.0)`
- `glue`
- `tensorflow (>= 1.14.0)`
- The package includes comprehensive unit tests for all core functions.
- Test coverage is reported using `covr` and available on Codecov at:
https://app.codecov.io/gh/mtwesley/greta.censored?branch=main

### Additional Information

Expand All @@ -37,4 +69,4 @@ All checks passed without errors or warnings.

- Mlen-Too Wesley <[email protected]>

Thank you for considering the `greta.censored` package for CRAN.
Thank you for considering the `greta.censored` package for CRAN.

0 comments on commit 659bc61

Please sign in to comment.