Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consistency in citations #72

Closed
chstock opened this issue Nov 9, 2023 · 5 comments
Closed

Consistency in citations #72

chstock opened this issue Nov 9, 2023 · 5 comments
Assignees

Comments

@chstock
Copy link
Collaborator

chstock commented Nov 9, 2023

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
Copy link
Collaborator

wlandau commented Nov 14, 2023

It would be nice to automate all this, but after reading GeoBosh/Rdpack#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
Copy link
Collaborator Author

chstock commented Nov 14, 2023

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
Copy link
Collaborator

wlandau commented Feb 8, 2024

In 8b7022e, 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
Copy link
Collaborator Author

chstock commented Feb 9, 2024

Thanks, @wlandau. I have one minor comment: 8b7022e#r138456839

@wlandau
Copy link
Collaborator

wlandau commented Feb 9, 2024

Great point, should be fixed in 5d02652

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants