Skip to content

Commit

Permalink
Add citation details to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-edwards committed Jan 5, 2024
1 parent 9b364dc commit a72fda6
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 4 deletions.
18 changes: 16 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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."
<https://github.com/pbs-assess/pacea>.

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
Expand Down Expand Up @@ -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`
Expand Down
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.”
<https://github.com/pbs-assess/pacea>.

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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit a72fda6

Please sign in to comment.