search

meghapsimatrix / simhelpers

Helper package to assist in running simulation studies
10 stars 3 forks source link

Use a .bibtex bibliography #8

Closed jepusto closed 4 years ago

jepusto commented 4 years ago

Given that the vignettes include a lot of citations, and the references are similar across different vignettes, it might be good to version control the citations with a .bibtext bibliography. Then the vignettes and README could use automatic citation references.

Right now the Morris et al. paper is cited as (2018), but the reference listed is actually 2019. Using the automatic citation references would make it easy to correct this.

meghapsimatrix commented 4 years ago

I did automatic citation but it gives me a note for the README: image

Good thing you pointed this out because I had peoples' first names as their last names 🤕 🤒

I will keep editing to clean up any messes. Thanks so much!!!

jepusto commented 4 years ago

It's probably worth doing a little bit of googling or tweeting to figure out where to put the csl and bibliography files in a package. Others have surely had the same problem.

On Wed, Mar 25, 2020 at 4:21 PM Megha Joshi notifications@github.com wrote:

I did automatic citation but it gives me a note for the README: [image: image] https://user-images.githubusercontent.com/33493716/77586510-55bf7200-6eb4-11ea-8bc1-f4bc9304648f.png

Good thing you pointed this out because I had peoples' first names as their last names 🤕 🤒

I will keep editing to clean up any messes. Thanks so much!!!

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/meghapsimatrix/simhelpers/issues/8#issuecomment-604094291, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABCVGIQFCCPXTLMVLFPPPITRJJYVVANCNFSM4LTWVWJA .

meghapsimatrix commented 4 years ago

I think I am going to do manual citation just for README because the pkgdown home page ref section looks like this with the automatic citation:

image

But, on the README thing on GitHub rep page for simhelpers, the citations look fine. Also adding the citations to README created a _main.Rmd file and a libs file which I am pretty sure wasn't there before. When I do manual citation for README, I don't get any notes when I do CMD check.

The vignette citations are fine though. I have citations and csl stuff in vignettes folder right now. I will do some exploring about citations stuff for packages. Or I might just be like whatevs donkeys [@lucy] 😺

jepusto commented 4 years ago

Makes sense. I fully support the WED approach.

Sent from my iPhone

On Mar 25, 2020, at 4:50 PM, Megha Joshi notifications@github.com wrote:

I think I am going to do manual citation just for README because the pkgdown home page ref section looks like this with the automatic citation:

But, on the README thing on GitHub rep page for simhelpers, the citations look fine. Also adding the citations to README created a _main.Rmd file and a libs file which I am pretty sure wasn't there before. When I do manual citation for README, I don't get any notes when I do CMD check.

The vignette citations are fine though. I have citations and csl stuff in vignettes folder right now. I will do some exploring about citations stuff for packages. Or I might just be like whatevs donkeys [@lucy] 😺

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or unsubscribe.