Centralize references in the rbmi documentation

Open
#591 0 comments 3 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
r
Domain
documentation

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.

Description

enhancement

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

Dominant language
R
Stars
21
Forks
13
Avg merge
13h 22m
Merged PRs (30d)
7

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from openpharma/rbmi

All issues in openpharma/rbmi

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.