Skip to content

docs: make citation guidance unmissable (defm) - #9

Merged
gvegayon merged 1 commit into
masterfrom
citation/how-to-cite
Aug 6, 2026
Merged

gvegayon merged 1 commit into
masterfrom
citation/how-to-cite

Conversation

@gvegayon

@gvegayon gvegayon commented Aug 6, 2026

Copy link
Copy Markdown
Member

Makes citation guidance for defm 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/CITATION

  • Year = (capital Y) is not a bibentry field and was being ignored; now year.
  • Removed a duplicated archivePrefix argument.
  • The package entry rendered (????) (reads meta$Date, no Date: in DESCRIPTION).
  • Added the CRAN DOI 10.32614/CRAN.package.defm to the package entry (CRAN began minting these in 2024).
  • The year is now resolved from Date/Publication → Date → current year, so the entry cannot render as (????).

Documentation

  • README: a > [!NOTE] "How to cite" callout near the top. Both the source (.qmd/.Rmd) and the rendered README.md are updated; the block is static markdown, so no re-render was required.
  • Startup message: a one-line packageStartupMessage on attach pointing at citation("defm"). 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.
  • All R/*.R files still parse() and all man/*.Rd still pass tools::parse_Rd().
  • Every DOI referenced here was checked to resolve; volumes, issues and pages were verified against CrossRef.

🤖 Generated with Claude Code

- `Year = ` (capital Y) is not a `bibentry` field and was being ignored; now `year`.
- Removed a duplicated `archivePrefix` argument.
- The package entry rendered `(????)` (reads `meta$Date`, no `Date:` in DESCRIPTION).

Adds a How to cite note to the README, vignettes and ?defm, plus a startup message, and adds the CRAN DOI.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

Thank you for your contribution @gvegayon 🚀! The pkgdown site preview is ready for review 👉 Download here 👈!
(The artifact expires on 2026-11-04T07:02:52Z. You can re-generate it by re-running the workflow here.)

@codecov

codecov Bot commented Aug 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.45%. Comparing base (b016e3a) to head (387d63e).

Additional details and impacted files
@@            Coverage Diff             @@
##           master       #9      +/-   ##
==========================================
+ Coverage   81.37%   81.45%   +0.08%     
==========================================
  Files           8        9       +1     
  Lines         451      453       +2     
==========================================
+ Hits          367      369       +2     
  Misses         84       84              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gvegayon
gvegayon merged commit 53d05f8 into master Aug 6, 2026
13 checks passed
@gvegayon
gvegayon deleted the citation/how-to-cite branch August 6, 2026 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant