search

openpharma / brms.mmrm

R package to run Bayesian MMRMs using {brms}
https://openpharma.github.io/brms.mmrm/
Other
18 stars 2 forks source link

Consistency in citations #72

Closed chstock closed 9 months ago

chstock commented 1 year ago

Consistency in citations of methodological literature (in vignettes and elsewhere in the package documentation) seems desirable. I suggest to take all references from a central BibTeX file (inst/bibliography.bib) and use one citation style (inst/asa.csl) throughout the package. Literature references are currently used in vignettes, the DESCRIPTION, README.Rmd, brm_package.R(\Rd) and maybe at other places. I'd be happy to go through the package and prepare a PR.

wlandau commented 1 year ago

It would be nice to automate all this, but after reading https://github.com/GeoBosh/Rdpack/issues/31, it is not clear to me how to apply inst/asa.csl to Rd files. One alternative is to include a package-level references section at the bottom of README.Rmd and then let the Rd files point there. In that section, we could omit references from vignettes and only include ones from functions. How does that sound?

chstock commented 1 year ago

Oh, thanks, I wasn't aware of this and had assumed it would work. I am happy with what you propose (or even to use what Rdpack offers, i.e. not to use .csl).

wlandau commented 9 months ago

In 8b7022e9a6d258dfc27e2577a2e50b425c3db312, I made sure all vignettes with references use:

bibliography: '`r system.file("bibliography.bib", package = "brms.mmrm")`'
csl: '`r system.file("asa.csl", package = "brms.mmrm")`'

and I manually updated all the references in R/brm_package.R are copy/pasted from those rendered reference sections. I think this makes all citations consistent. @chstock, please let me know if there is something I missed.

chstock commented 9 months ago

Thanks, @wlandau. I have one minor comment: https://github.com/openpharma/brms.mmrm/commit/8b7022e9a6d258dfc27e2577a2e50b425c3db312#r138456839

wlandau commented 9 months ago

Great point, should be fixed in 5d02652162eb19c5ff98df5e07e280de1dc51059