docs: make citation guidance unmissable (netdiffuseR) - #85
Open
gvegayon wants to merge 3 commits into
Open
Conversation
- **Corrected the journal volume: 42 → 47.** The Health Education & Behavior paper is 47(2), 235-248 — the file's own `textVersion` already said 47. - Removed the incorrect ISSN `1367-4803` (that is *Bioinformatics*') in favour of HEB's `1090-1981`. Adds a How to cite note to the README, vignettes and ?netdiffuseR, plus a startup message, and adds the CRAN DOI. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR makes citation guidance for netdiffuseR more prominent across vignettes and the README, adds a startup attach message pointing users to citation("netdiffuseR"), and corrects/modernizes the package’s inst/CITATION metadata.
Changes:
- Added “How to cite” callouts to 6 vignettes and the README.
- Added an
.onAttach()startup message to encourage citation on package attach. - Updated
inst/CITATION(volume/issue fields, ISSN, CRAN DOI, and year resolution).
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| vignettes/time_discount_suscep_infect.Rmd | Adds a short “How to cite” blockquote near the top. |
| vignettes/simulating-multiple-behaviors-on-networks.Rmd | Adds a short “How to cite” blockquote near the top. |
| vignettes/rdiffnets.Rmd | Adds a short “How to cite” blockquote near the top. |
| vignettes/not-lost-in-translation-importing-and-exporting-graphs.Rmd | Adds a short “How to cite” blockquote near the top. |
| vignettes/introduction-to-netdiffuser.Rmd | Adds a short “How to cite” blockquote near the top. |
| vignettes/analyzing-medical-innovation-data.Rmd | Adds a short “How to cite” blockquote near the top. |
| README.qmd | Adds a prominent citation callout (currently placed inside an R code chunk). |
| README.md | Mirrors the README citation callout (currently placed inside a fenced code block). |
| R/zzz.R | Introduces .onAttach() startup message encouraging citation. |
| inst/CITATION | Corrects article metadata and improves package citation entry (year resolution + CRAN DOI). |
Comment on lines
+108
to
+112
| ```{r plot_infectsuscept} | ||
| # Generating a random graph | ||
|
|
||
| <!-- how-to-cite --> | ||
| > [!NOTE] |
Contributor
There was a problem hiding this comment.
Fixed in the latest commit — the callout is now placed directly above the plot_infectsuscept code chunk instead of inside it.
Comment on lines
131
to
+136
| ``` r | ||
| # Generating a random graph | ||
|
|
||
| <!-- how-to-cite --> | ||
| > [!NOTE] | ||
| > **How to cite netdiffuseR.** If you use **netdiffuseR** in published work, please cite it: |
Comment on lines
+1
to
+5
| .onAttach <- function(libname, pkgname) { | ||
| packageStartupMessage( | ||
| "Using netdiffuseR in your research? Please cite it: citation(\"netdiffuseR\")" | ||
| ) | ||
| } |
Co-authored-by: gvegayon <893619+gvegayon@users.noreply.github.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.
Makes citation guidance for netdiffuseR 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/CITATIONtextVersionalready said 47.1367-4803(that is Bioinformatics') in favour of HEB's1090-1981.10.32614/CRAN.package.netdiffuseRto 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("netdiffuseR"). 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().🤖 Generated with Claude Code