CRAN prep: DESCRIPTION, NEWS, cran-comments, CITATION#62
Merged
Conversation
- DESCRIPTION: replace placeholder Description with real package summary covering the Bayesian hierarchical coverage model, B-spline smoothed cohort effects, optional county/school random effects, and Stan/rstan implementation. Bump version from 0.0.0.9000 to 0.1.0. - NEWS.md (new): initial release entry enumerating exported functions (sampling, predict.imugap_fit, extract_imugap, canonicalize_*, imugap_options, stan_options), bundled Stan models (stateonly + v6), bundled datasets (locations_sim, observations_sim, populations_sim, fit_sim), and the pkgdown site. - cran-comments.md (new): first-submission template with placeholders for @csmith701 to fill in package-specific notes before release. - CITATION.cff (new): CFF 1.2.0 metadata file with Carl Pearson (cre) and Claire Perrin Smith (aut) as the cited authors, MIT license, v0.1.0, and repository/URL pointing at the GitHub repo and pkgdown site so Zenodo can pick it up on release. - .Rbuildignore: ignore cran-comments.md and CITATION.cff (NEWS.md is intentionally NOT ignored so it ships in the source tarball per CRAN convention). Verified locally with R CMD build .: succeeds and produces imuGAP_0.1.0.tar.gz containing NEWS.md but neither cran-comments.md nor CITATION.cff. Refs #31.
WestonVoglesonger
force-pushed
the
issue-31-cran-prep
branch
from
b72280f to
0f7af1a
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
csmith701
reviewed
May 29, 2026
csmith701
reviewed
May 29, 2026
csmith701
reviewed
May 29, 2026
Comment on lines
+40
to
+42
| - Bundled example datasets (`locations_sim`, `observations_sim`, | ||
| `populations_sim`, `fit_sim`) are simulated and small; `fit_sim` is a | ||
| wiring fixture for examples and tests, not a converged posterior. |
Contributor
There was a problem hiding this comment.
Note that we will update this when we update the package data to reflect new prediction capabilities.
csmith701
reviewed
May 29, 2026
csmith701
reviewed
May 29, 2026
csmith701
reviewed
May 29, 2026
csmith701
reviewed
May 29, 2026
csmith701
reviewed
May 29, 2026
csmith701
approved these changes
May 29, 2026
Contributor
csmith701
left a comment
csmith701
left a comment
There was a problem hiding this comment.
Approved pending suggested changes
Comment on lines
+24
to
+26
| - Bundled example datasets for end-to-end examples and tests: | ||
| `locations_sim`, `observations_sim`, `populations_sim`, and the | ||
| reference `fit_sim` `stanfit` fixture. |
Contributor
There was a problem hiding this comment.
To be updated when I update package data
Co-authored-by: Claire P. Smith <63207423+csmith701@users.noreply.github.com>
Co-authored-by: Claire P. Smith <63207423+csmith701@users.noreply.github.com>
Co-authored-by: Claire P. Smith <63207423+csmith701@users.noreply.github.com>
Co-authored-by: Claire P. Smith <63207423+csmith701@users.noreply.github.com>
Co-authored-by: Claire P. Smith <63207423+csmith701@users.noreply.github.com>
Co-authored-by: Claire P. Smith <63207423+csmith701@users.noreply.github.com>
Co-authored-by: Claire P. Smith <63207423+csmith701@users.noreply.github.com>
Co-authored-by: Claire P. Smith <63207423+csmith701@users.noreply.github.com>
Member
|
@WestonVoglesonger good for now; @csmith701 and I will do some more triage when resolving the package data update, per the comments, and then may request a clean up pass. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR A of #31's plan. Adds the metadata files needed for first CRAN submission. Touches only
DESCRIPTION, 3 new top-level files, and.Rbuildignore.DESCRIPTION: replaces boilerplateDescription:with a real summary; bumpsVersion:to0.1.0(per Carl's "conventional" call on Submit to CRAN #31).NEWS.md(new): initial# imuGAP 0.1.0entry enumerating the exported surface.cran-comments.md(new): first-submission template with[bracketed placeholders]for Claire to fill in package-specific content (per Carl: "draft please, then let's have @csmith701 do detailed content").CITATION.cff(new): CFF 1.2.0; Carl + Claire as authors with ORCIDs.ctbcontributors omitted (easy to add if you prefer)..Rbuildignore: addscran-comments.md+CITATION.cff; intentionally does NOT addNEWS.md(belongs in the tarball per CRAN convention).Verified
R CMD build .succeeds and producesimuGAP_0.1.0.tar.gzcontainingNEWS.mdbut notcran-comments.md/CITATION.cff.@pearsonca: please confirm the
Description:wording + version bump.@csmith701: please fill in
cran-comments.mdplaceholders before we tag the release.Refs #31.