Add references to documentation

[brunaw]

Should we have a .bib file to put the references used?

[alexpghayes]

I'd prefer to put references directly in the function documentation, so that there isn't an extra step for users to find them. Ideally we should include a URL to a copy of the reference in the function documentation as well.

[brunaw]

Absolutely! but I guess the references for each documentation could be created with a unified .bib file that we just use to cite?

[alexpghayes]

Oh I did know this was possible. Can you shoot me a link to an example / documentation on how this works?

On Mon, Sep 2, 2019, 10:26 AM Bruna Wundervald [email protected] wrote:

Absolutely! but I guess the references for each documentation could be created with a unified .bib file that we just use to cite?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/alexpghayes/distributions3/issues/17?email_source=notifications&email_token=ADTBG27SWBGWAMV6U3CWUBDQHUWBLA5CNFSM4HWG7QLKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5WDF4I#issuecomment-527184625, or mute the thread https://github.com/notifications/unsubscribe-auth/ADTBG2ZLWI7XB4C2VNKTBYTQHUWBLANCNFSM4HWG7QLA .

[brunaw]

I actually never did it myself :p but I remember seeing it a few times. I found this tutorial which might be exactly what we want: https://cran.r-project.org/web/packages/Rdpack/vignettes/Inserting_bibtex_references.pdf

[alexpghayes]

I may do this down the line if I teach with distributions3, but otherwise this probably won't happen unless someone is excited about it.