minor clean up and add use example to index.Rmd

NEWS.md

@@ -1,28 +1,28 @@
 # VRData
 
-## Version 2.3
+# Version 2.3
 
 Variety of clean-up in order to pass R CMD check
 
 * Standardize file names
 * Fix declaring of global objects in the dplyr calls
 * Do not install inst/extdata (misc info and raw SPS files)
 
-## Version 2.2
+# Version 2.2
 
 * Data updated to the the SPS upload file for the 2020 Viability Report.
 * Added raw data downloading and viewing.
 * Misc clean-up: added citation for Viability Report 2022, changed logo to hex, change installation to release instead of main branch, added more info to DESCRIPTION
 
-## Version 2.1
+# Version 2.1
 
 * Fleshed out the contributor and citation sections for each Rd file.
 
-## Version 2.0
+# Version 2.0
 
 Data from the 2020 Viability report. Removed the header info from the raw data files. This info is now being build from the columns of the raw data.
 
-## Version 1.0
+# Version 1.0
 
 Spawner and fraction wild data from the first release of the 2015 NWFSC PNW Salmonid Viability Report. The data were later updated after public comment.
 

index.Rmd

@@ -18,13 +18,26 @@ NMFS-NWFSC-171. https://doi.org/10.25923/kq2n-ke70
 
 ## Installation
 
-To install, install the **devtools** package (if needed) and then use:
+Install the **devtools** package (if needed) and then use:
 ```
 library(devtools)
 devtools::install_github("nwfsc-math-bio/VRData@*release")
 library(VRData)
 ```
 
+## To use
+
+To use the data in R, see the examples under the `Data info` tab. For example to make a plot of the spawners, you could use
+```
+data('Puget Sound-PSchinook2020')
+library(ggplot2)
+out$NUMBER_OF_SPAWNERS[out$NUMBER_OF_SPAWNERS==-99] <- NA
+ggplot(out, aes(x=YEAR, y=NUMBER_OF_SPAWNERS)) + 
+  geom_point(na.rm = TRUE) +
+  ggtitle('Puget Sound-PSchinook2020') +
+  facet_wrap(~COMMON_POPULATION_NAME))
+```      
+
 ****
 
 ```{r add-disclaimer, echo=FALSE, results='asis'}