Centralize references in the rbmi documentation
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- R
- Stars
- 21
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
It's now possible to centralize all bibliographic references in a single BibTeX file, e.g., inst/REFERENCES.bib.
The Rd help pages can cite it via Rdpack (\insertRef), and the vignettes can use a Makefile-generated copy (vignettes/references.bib) so references are defined in one place only and re-usable across the documentation
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the existing Rd help pages, vignettes, inst/REFERENCES.bib, and the Makefile. Use the BibTeX file as the single reference source and ensure the vignettes/references.bib copy is generated for vignette citations. Done means the documentation cites reusable references without duplicate definitions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100