Added a Citations section to the GitHub page that shows sources that …

…have cited their use of the heatwaveR package

.Rbuildignore

@@ -18,3 +18,4 @@
 ^logo.png
 ^pkgdown
 ^index-1.html
+^CITATIONS.md

CITATIONS.md

@@ -0,0 +1,11 @@
+# Scientific literature
+
+***
+
+## 2019
+
+- Westover, M. L. (2019). Biogeographical implications of climate change for an alpine mammal, the American pika.
+
+- Zhao, Z., & Marin, M. (2019). A MATLAB toolbox to detect and analyze marine heatwaves. The Journal of Open Source Software, 4, 1124.
+
+***

README.Rmd

@@ -1,7 +1,7 @@
 ---
 output:
   md_document:
-    variant: markdown_github
+    variant: gfm
     fig_width: 8
     fig_height: 3
     # pandoc_args: ["--smart"]
@@ -129,7 +129,7 @@ Note that `rate_onset` and `rate_decline` will return `NA` when the event begins
 
 ## The Vignettes
 
-For detailed explanations and walkthroughs on the use of the __`heatwaveR`__ package please click on the articles tab in the toolbar above, or follow the links below:
+For detailed explanations and walkthroughs on the use of the __`heatwaveR`__ package please click on the Vignettes tab in the toolbar above, or follow the links below:
 
   * For a basic introduction to the [detection and visualisation](https://robwschlegel.github.io/heatwaveR/articles/detection_and_visualisation.html) of events.
   * For an explanation on the use of the [exceedance](https://robwschlegel.github.io/heatwaveR/articles/exceedance.html) function.
@@ -148,6 +148,18 @@ To contribute to the package please follow the guidelines [here](https://robwsch
 
 Please use this [link](https://github.com/robwschlegel/heatwaveR/issues) to report any bugs found.
 
+## Citing __`heatwaveR`__ 
+
+Because __`heatwaveR`__ is and always will be free to use open source software, its citation in scientific literature and other sources is the primary metric through which the continued development of this package is motivated for. Therefore, if the __`heatwaveR`__ package is used in any analyses please acknowledge this through the following citation:
+
+Robert W. Schlegel and Albertus J. Smit (2018). heatwaveR: A central algorithm for the detection of heatwaves and cold-spells. Journal of Open Source Software, 3(27), 821, https://doi.org/10.21105/joss.00821
+
+The BibTeX citation may be accessed in R with:
+
+`citation("heatwaveR")`
+
+For a list of sources that have cited __`heatwaveR`__ see the Citations tab in the toolbar at the top of this page. If you do not see your publication in the list of citations and would like it added please contact the developer (see below).
+
 ## References
 
 Hobday, A.J. et al. (2016). A hierarchical approach to defining marine heatwaves. Progress in Oceanography, 141, pp. 227-238.

_pkgdown.yml

@@ -8,7 +8,7 @@ navbar:
     href: index.html
   - text: "Reference"
     href: reference/index.html
-  - text: "Articles"
+  - text: "Vignettes"
     menu:
     - text: "Basic Detection and Visualisation of Events"
       href: articles/detection_and_visualisation.html
@@ -22,7 +22,9 @@ navbar:
       href: articles/gridded_event_detection.html
     - text: "Alternative Thresholds"
       href: articles/complex_clims.html
-  - text: News
+  - text: "Citations"
+    href: CITATIONS.html
+  - text: "News"
     href: news/index.html
   right:
   - icon: fa-github fa-lg
@@ -45,6 +47,7 @@ reference:
 - title: Data
   desc: ~
   contents:
+  - '`Algiers`'
   - '`sst_Med`'
   - '`sst_NW_Atl`'
   - '`sst_WA`'