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

add url and other stuff to DESCRIPTION files in all packages to improve citation? #28

Open
iantaylor-NOAA opened this issue Jun 30, 2023 · 0 comments
Labels
documentation Issues related to documentation. No changes to the code base.

Comments

@iantaylor-NOAA
Copy link
Contributor

Running citation("nwfscDiag") provides useful stuff including the url that I think is great for adding to our .bib files in our assessment reports:

To cite package 'nwfscDiag' in publications use:

  Wetzel C (2023). _nwfscDiag: Generate standard NWFSC assessment diagnostics_. R package version 1.1.1,
  <https://github.com/pfmc-assessments/nwfscDiag>.

A BibTeX entry for LaTeX users is

  @Manual{,
    title = {nwfscDiag: Generate standard NWFSC assessment diagnostics},
    author = {Chantel Wetzel},
    year = {2023},
    note = {R package version 1.1.1},
    url = {https://github.com/pfmc-assessments/nwfscDiag},
  }

On the other hand {PacFIN.Utilities} and {nwfscSurvey} have no url (but are otherwise awesome and helpful which is why I want to site them. For now I've just manually added the urls to my supplemental .bib file: https://github.com/pfmc-assessments/petrale/blob/main/documents/extra_citations.bib.

The citation() function leads to a warning about "no date field in DESCRIPTION file ...", but the R package book says

We discourage the explicit use of the Date field, as it is extremely easy to forget to update it if you manage Date by hand. This field will be populated in the natural course of bundling the package, e.g. when submitting to CRAN, and we recommend that you just let that happen.
For packages that don't get submitted to CRAN, I don't know if there's some other "natural course", so I'm guessing we should just ignore the warning.

Figuring out how to keep these citations up to date if they get added to the sa4ss.bib file is another question.

@iantaylor-NOAA iantaylor-NOAA added the documentation Issues related to documentation. No changes to the code base. label Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related to documentation. No changes to the code base.
Projects
None yet
Development

No branches or pull requests

1 participant