Add the FishBase team's message to users - #326
Merged
Merged
Conversation
The FishBase team asked us to pass on a request that users report mistakes, typos and taxonomic issues, and share publications and references, directly to fishbase@q-quatics.org. Placed in the README and on the package help page, rather than as a startup message, which would nag regular users on every attach. Two fixes fell out of doing this: `?rfishbase` produced no help page at all. The roxygen block in R/fishbase.R used `@docType _PACKAGE` instead of the `"_PACKAGE"` sentinel, so roxygen skipped the block silently and man/rfishbase-package.Rd was never generated. `.Rbuildignore` did not exclude imports/. R matches these patterns against paths without a trailing slash, so `^imports/$` never fired and the FishBase dumps were bundled into the built package: the 5.0.4 tarball was 183 MB against 592 KB with the pattern corrected to `^imports$`.
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.
Passes on the notice the FishBase team asked us to carry.
Placement
README (both
README.RmdandREADME.md) and the package help page (?rfishbase) — as a blockquote under "A message from the FishBase team", placed right after the existing "we welcome any feedback" paragraph.Agreed on skipping a startup message: it would nag regular users on every attach. The help page is worth having alongside the README because someone who installs from CRAN may never visit GitHub, and
?rfishbasecosts nothing at runtime.One thing to fix before merging: in the message as sent, "Please send your comments and corrections here" was a hyperlink, but the target didn't survive the paste. Rather than guess a URL, I wrote "Please send your comments and corrections to fishbase@q-quatics.org. You may send PDF files directly to the same address." Give me the intended link and I'll restore their original wording. Everything else is verbatim; I only restored the bullet structure, which had flattened into a paragraph.
Two fixes that fell out of this
?rfishbaseproduced no help page at all. The roxygen block inR/fishbase.Rused@docType _PACKAGEinstead of the"_PACKAGE"sentinel, so roxygen skipped the whole block silently —man/rfishbase-package.Rdwas never generated. Found it when the new@sectionproduced no output. Fixed, so the package now has a landing help page for the first time..Rbuildignorewas not excludingimports/. R matches these patterns against paths without a trailing slash, so^imports/$never fired and the FishBase dumps were being bundled into the built package. The 5.0.4 tarball was 183 MB; with the pattern corrected to^imports$it is 592 KB. This came in with #324, so it has not reached CRAN.R CMD check --as-cran: Status: OK, no warnings or notes (theimportstop-level NOTE is gone with the fix).Worth a glance
DESCRIPTIONswapsRoxygenNote: 7.3.3forConfig/roxygen2/version: 8.0.0, andman/reexports.Rdgets a one-line link-target update — both are just my local roxygen being newer. Say the word and I'll pin them back.inst/WORDLISTgainspdfsandquatics. The spelling test runs witherror = FALSEso it would not have failed CI either way.Not merging this one — it is your call whether the placement is right.