Package hygiene: metadata, CITATION, CI workflows, R CMD check fixes#11
Merged
Conversation
- DESCRIPTION: replace placeholder Title with a real one; convert
Author/Maintainer to Authors@R; add URL and BugReports; expand
Description with the paper DOIs; drop the no-op LazyData field.
- hfromd.R: use inherits(result, "try-error") instead of comparing
class() to a string (clears an R CMD check NOTE; robust in R 4.x).
- Add inst/CITATION (2023 paper + 2024 correction) so
citation("taperNOR") works.
- Add GitHub Actions workflows: R-CMD-check across linux/macos/windows
and pytest for the python/ package.
- .Rbuildignore: exclude python/, .github/, .git/, .gitignore so they
are not bundled into the R source tarball.
Fixes the LICENSE stub typo ("taperNO" -> "taperNOR"). R CMD check
--as-cran goes from 3 NOTEs to 2 (only the benign "New submission" and
the local "pandoc not installed" notes remain; both are expected and the
pandoc one disappears on CI). The MIT license stub is kept in the
CRAN-standard format, so GitHub still reports the license as "Other" --
an accepted trade-off to keep R CMD check clean.
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
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
Package-hygiene pass — no change to model behaviour. Brings
R CMD check --as-cranfrom 3 NOTEs down to 2 (the two remaining are the benign "New submission" and a local-only "pandoc not installed" note that disappears on CI).DESCRIPTION
Title: What the Package Does (Title Case)with a real title.Author/MaintainertoAuthors@R(clears the CRAN-incoming NOTE).URLandBugReports.Descriptionand cite the paper + correction DOIs.LazyData: true(no-op here — coefficients live in internalR/sysdata.rda; the build already omitted it).Code
hfromd.R: useinherits(result, "try-error")instead ofclass(result) == "try-error"(clears the "comparing class() to string" NOTE; robust against R 4.x's length-2class()).Packaging / docs
inst/CITATION(2023 paper + 2024 correction) socitation("taperNOR")works — verified it renders both entries..github/workflows/R-CMD-check.yaml(linux/macOS/windows, r-lib/actions) and.github/workflows/pytest.yaml(runs thepython/suite on 3.9/3.11/3.13)..Rbuildignore: excludepython/,.github/,.git/,.gitignoreso they aren't bundled into the R source tarball (thepython/dir would otherwise trigger a top-level-files NOTE).taperNO authors→taperNOR authors.Note on the GitHub license badge
GitHub currently shows the repo license as "Other". This is because GitHub's
licenseekeys on the bareLICENSEfile, which — per the R/CRANMIT + file LICENSEconvention — is a 2-line stub (YEAR:/COPYRIGHT HOLDER:) thatlicenseecan't match to MIT, even thoughLICENSE.mdis full MIT. Making GitHub display "MIT" would require putting the full licence text inLICENSE, which costs 1–2R CMD checkNOTEs. I kept the CRAN-clean stub instead (verified: 0 license NOTEs). The package is unambiguously MIT-licensed viaDESCRIPTION+LICENSE.md.Test plan
R CMD check --as-cran(R 4.6.0): OK, 2 NOTEs (New submission; pandoc-not-installed — both benign)citation("taperNOR")renders both references