Repository navigation
docs: make citation guidance unmissable (multigroup.vaccine) - #85
Merged
Merged
Conversation
- The entry hard-coded the year and `R package version 0.1.1`; both now track the package metadata. Adds a How to cite note to the README, vignettes and ?multigroup.vaccine, plus a startup message, and adds the CRAN DOI. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR makes citation guidance for the multigroup.vaccine R package highly visible across key user entry points (README + vignettes + attach-time message) and updates inst/CITATION so the rendered citation tracks package metadata (version/year) and includes the CRAN DOI.
Changes:
- Added prominent “How to cite” callouts to the README and four vignettes.
- Added an attach-time startup message pointing users to
citation("multigroup.vaccine"). - Updated
inst/CITATIONto derive year/version from package metadata and include the CRAN DOI.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| vignettes/run_model_on_command_line.Rmd | Adds a short “How to cite” callout near the top of the vignette. |
| vignettes/measles_agemodel.Rmd | Adds a short “How to cite” callout near the top of the vignette. |
| vignettes/contact_matrix_examples.Rmd | Adds a short “How to cite” callout near the top of the vignette. |
| vignettes/census_functions_demo.Rmd | Adds a short “How to cite” callout near the top of the vignette. |
| README.Rmd | Adds a prominent “How to cite” note block in the source README. |
| README.md | Adds the rendered “How to cite” note block to the published README. |
| R/zzz.R | Adds .onAttach() startup message directing users to citation("multigroup.vaccine"). |
| inst/CITATION | Updates citation entry to use package metadata for year/version and adds the CRAN DOI. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
18
to
+22
| <!-- badges: start --> | ||
|
|
||
| <!-- how-to-cite --> | ||
| > [!NOTE] | ||
| > **How to cite multigroup.vaccine.** If you use **multigroup.vaccine** in published work, please cite it: |
Comment on lines
+1
to
+5
| .onAttach <- function(libname, pkgname) { | ||
| packageStartupMessage( | ||
| "Using multigroup.vaccine in your research? Please cite it: citation(\"multigroup.vaccine\")" | ||
| ) | ||
| } |
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.
Makes citation guidance for multigroup.vaccine hard to miss, and corrects the citation metadata.
Motivation: the package has far more users than citations, and the usual reason is that people cannot find what to cite. Every change below is aimed at that gap.
inst/CITATIONR package version 0.1.1; both now track the package metadata.10.32614/CRAN.package.multigroup.vaccineto the package entry (CRAN began minting these in 2024).Date/Publication→Date→ current year, so the entry cannot render as(????).Documentation
> [!NOTE]"How to cite" callout near the top. Both the source (.qmd/.Rmd) and the renderedREADME.mdare updated; the block is static markdown, so no re-render was required..callout-notein.qmd, a blockquote in.Rmd).packageStartupMessageon attach pointing atcitation("multigroup.vaccine"). It is suppressible in the normal way and does not fire on::.Verification
utils::readCitationFile()parses the new file against the package DESCRIPTION, and the rendered entries were inspected.R/*.Rfiles stillparse()and allman/*.Rdstill passtools::parse_Rd().Note
Opened by a co-author — you maintain this package, so please review the startup message and wording and adjust to taste.
🤖 Generated with Claude Code