CRAN readiness: \value, examples, spelling, NEWS, cran-comments#12
Merged
Conversation
- plot_taper(): add \value documenting it is called for its plotting side effect (CRAN requires \value on all exported functions; this was the only one missing it). - kublin_nor(): add a runnable spruce example (the other exported functions already had examples). - Spelling: add inst/WORDLIST for domain terms, proper nouns, species aliases, and foreign-language citation text; add tests/spelling.R and 'spelling' to Suggests; declare Language: en-US. spell_check is now clean. - Add NEWS.md and a cran-comments.md submission template (the latter is .Rbuildignore'd so it is not shipped in the tarball). R CMD check --as-cran: 0 errors, 0 warnings; remaining notes are the expected "New submission" and the environment-only "pandoc not installed" (absent on CI). testthat: 39 pass. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
citation("taperNOR") now returns a package/software entry first, with
Rahlf as lead author and Hansen as co-author (matching Authors@R and the
agreed credit split: Hansen leads the paper, Rahlf leads the software),
followed by the underlying Hansen et al. (2023) paper and its 2024
correction. Per-entry headers explain which to cite for what.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Use a fixed 2023 (when version 0.1.0 was published alongside the paper) instead of the current year, so the citation is stable/reproducible and reflects the actual release year. Update on future version releases. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Summary
Closes the remaining gaps so the package passes CRAN's automated and reviewer checks. No change to model behaviour.
plot_taper()\value— added (CRAN requires\valueon every exported function; this was the only one missing it). Documented as called for its plotting side effect.kublin_nor()example — added a runnable spruce example; the other six exported functions already had examples.inst/WORDLIST(domain terms likeKozak/Kublin/TapeR/DHx, proper nouns, species aliases, and the Swedish citation text in the bark reference),tests/spelling.R,spellinginSuggests, andLanguage: en-US.spelling::spell_check_package()is now clean.NEWS.md— added a changelog for 0.1.0.cran-comments.md— added a submission template (excluded from the build tarball via.Rbuildignore).Check results
R CMD check --as-cran(R 4.6.0): 0 errors, 0 warnings, and the only notes are:New submission— expected/unavoidable for a first CRAN submission.Files 'README.md' or 'NEWS.md' cannot be checked without 'pandoc'— environment-only; absent on CI and on CRAN's machines (which have pandoc).So on a CRAN-equivalent toolchain this is effectively a single
New submissionnote.testthat: 39 pass. Thespelling.Randtestthat.Rtest files both run during the check.Still part of the submission process (not package code)
Before actually submitting, you'd still want to:
devtools::check_win_devel()) and/or R-hub to test on r-devel (CRAN tests there; our CI only runs r-release).devtools::release()/ the CRAN web form and respond to the maintainer confirmation email.With those done, the package should be in good shape for CRAN.