From a72fda6de59269d3bb19e872b871e9646dde6bd9 Mon Sep 17 00:00:00 2001 From: andrew-edwards Date: Fri, 5 Jan 2024 12:00:48 -0800 Subject: [PATCH] Add citation details to README. --- README.Rmd | 18 ++++++++++++++++-- README.md | 20 ++++++++++++++++++-- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/README.Rmd b/README.Rmd index b24a3cde..337a7ab9 100644 --- a/README.Rmd +++ b/README.Rmd @@ -283,6 +283,21 @@ A comprehensive [2022 analysis of Canadian stock assessments](https://publicatio This work is strongly motivated by, and based on, the [GSLea](https://github.com/duplisea/gslea) R package by Dan Duplisea and colleagues for the Gulf of St Lawrence. +## Citation + +If you use `pacea` in your work then please cite it as + +Edwards AM, Tai TC, Watson J, Peña MA, Hilborn A, Hannah CG, Rooper + CN (2023). "pacea: An R package of Pacific ecosystem information to + help facilitate an ecosystem approach to fisheries management." + . + +You may wish to add the date you installed it (using `pacea_installed()`). Use +`citation("pacea")` to get a version for LaTeX and R Markdown bibliographies. + +Also let us know of any applications. This will help us devote effort into +maintaining `pacea`. + ## Acknowledgments This work is funded by a Competitive Science Research Fund grant from Fisheries @@ -320,8 +335,7 @@ coverage (as indicated in the badge at the top of the README on GitHub). variables and functions. 1. Citation information is in inst/CITATION, so if you update DESCRIPTION file -(e.g. add an author) then update that also, and may want to change the info at the -start of this file. +(e.g. add an author) then update that also and update the citation info above. 1. Logo included by running `use_logo("inst/pacea-logo-from-carley.png")`. The .png was expertly designed by Carley Colclough. There is also `inst/pacea-logo-for-printing.jpg` diff --git a/README.md b/README.md index 1308b9f1..d8e60969 100644 --- a/README.md +++ b/README.md @@ -264,6 +264,22 @@ This work is strongly motivated by, and based on, the [GSLea](https://github.com/duplisea/gslea) R package by Dan Duplisea and colleagues for the Gulf of St Lawrence. +## Citation + +If you use `pacea` in your work then please cite it as + +Edwards AM, Tai TC, Watson J, Peña MA, Hilborn A, Hannah CG, Rooper CN +(2023). “pacea: An R package of Pacific ecosystem information to help +facilitate an ecosystem approach to fisheries management.” +. + +You may wish to add the date you installed it (using +`pacea_installed()`). Use `citation("pacea")` to get a version for LaTeX +and R Markdown bibliographies. + +Also let us know of any applications. This will help us devote effort +into maintaining `pacea`. + ## Acknowledgments This work is funded by a Competitive Science Research Fund grant from @@ -304,8 +320,8 @@ logo. and functions. 6. Citation information is in inst/CITATION, so if you update - DESCRIPTION file (e.g. add an author) then update that also, and may - want to change the info at the start of this file. + DESCRIPTION file (e.g. add an author) then update that also and + update the citation info above. 7. Logo included by running `use_logo("inst/pacea-logo-from-carley.png")`. The .png was expertly