add citation

bcgov · Nov 29, 2018 · 5bd829d · 5bd829d
1 parent 609a551
commit 5bd829d
Show file tree

Hide file tree

Showing 20 changed files with 151 additions and 42 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,6 @@
 # ssdtools 0.0.3
 
+- added citation
 - Added ssdtools-manual vignette
 - Changed predict() and ssd_hc() nboot argument from 1001 to 1000
 - Added hc5_boron data object

diff --git a/README.Rmd b/README.Rmd
@@ -86,6 +86,8 @@ ssd_plot(boron_data, boron_pred, shape = "Group", color = "Group", label = "Spec
          xlab = "Concentration (mg/L)", ribbon = TRUE) + expand_limits(x = 3000)
 ```
 
+## Information
+
 The ssdtools manual is available at <https://bcgov.github.io/ssdtools/articles/ssdtools-manual.html>.
 
 A shiny webpage developed for non-R-users is available at <https://poissonconsulting.shinyapps.io/ssdtools/>.
@@ -96,6 +98,13 @@ The data included in `ssdtools` are sourced from the Canadian environmental qual
 
 To report bugs/issues/feature requests, please file an [issue](https://github.com/bcgov/ssdtools/issues/).
 
+## Citation
+
+```{r, comment = "", echo = FALSE}
+citation(package = "ssdtools")
+```
+
+
 ## How to Contribute
 
 If you would like to contribute to the package, please see our 

diff --git a/README.md b/README.md
@@ -123,6 +123,8 @@ ssd_plot(boron_data, boron_pred, shape = "Group", color = "Group", label = "Spec
 
 ![](man/figures/README-unnamed-chunk-10-1.png)<!-- -->
 
+## Information
+
 The ssdtools manual is available at
 <https://bcgov.github.io/ssdtools/articles/ssdtools-manual.html>.
 
@@ -141,6 +143,30 @@ folder for more information.
 To report bugs/issues/feature requests, please file an
 [issue](https://github.com/bcgov/ssdtools/issues/).
 
+## Citation
+
+``` 
+
+To cite ssdtools in publications use:
+
+  Thorley et al., (2018). ssdtools An R package to fit Species
+  Sensitivity Distributions. Journal of Open Source Software,
+  3(31), 1082. https://doi.org/10.21105/joss.01082
+
+A BibTeX entry for LaTeX users is
+
+  @Article{,
+    title = {{ssdtools}: An R package to fit Species Sensitivity Distributions},
+    author = {Joe Thorley and Carl Schwarz},
+    journal = {Journal of Open Source Software},
+    year = {2018},
+    volume = {3},
+    number = {31},
+    pages = {1082},
+    doi = {10.21105/joss.01082},
+  }
+```
+
 ## How to Contribute
 
 If you would like to contribute to the package, please see our

diff --git a/docs/articles/ssdtools-manual.html b/docs/articles/ssdtools-manual.html
diff --git a/docs/articles/ssdtools-manual_files/figure-html/unnamed-chunk-20-1.png b/docs/articles/ssdtools-manual_files/figure-html/unnamed-chunk-20-1.png
diff --git a/docs/articles/ssdtools-manual_files/figure-html/unnamed-chunk-21-1.png b/docs/articles/ssdtools-manual_files/figure-html/unnamed-chunk-21-1.png
diff --git a/docs/articles/ssdtools-manual_files/figure-html/unnamed-chunk-22-2.png b/docs/articles/ssdtools-manual_files/figure-html/unnamed-chunk-22-2.png
diff --git a/docs/articles/ssdtools-manual_files/figure-html/unnamed-chunk-6-1.png b/docs/articles/ssdtools-manual_files/figure-html/unnamed-chunk-6-1.png
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/reference/autoplot.fitdist.html b/docs/reference/autoplot.fitdist.html
diff --git a/docs/reference/autoplot.fitdistcens.html b/docs/reference/autoplot.fitdistcens.html
diff --git a/docs/reference/autoplot.fitdists.html b/docs/reference/autoplot.fitdists.html
diff --git a/docs/reference/autoplot.fitdistscens.html b/docs/reference/autoplot.fitdistscens.html
diff --git a/docs/reference/geom_hcintersect.html b/docs/reference/geom_hcintersect.html
diff --git a/docs/reference/geom_ssd.html b/docs/reference/geom_ssd.html
diff --git a/docs/reference/ssdtools-ggproto.html b/docs/reference/ssdtools-ggproto.html
diff --git a/docs/reference/stat_ssd.html b/docs/reference/stat_ssd.html