vignette info for water atlas api functions #62

Author: fawda123

vignettes/intro.Rmd

@@ -132,6 +132,29 @@ mancodata <- read_importwqp(org = '21FLMANA_WQX', type = 'wq', trace = T)
 pincodata <- read_importwqp(org = '21FLPDEM_WQX', type = 'wq', trace = T)
 ```
 
+Additionally, data can be retrieved from the Tampa Bay Water Atlas API (<https://dev.api.wateratlas.org/redoc/>) using two different functions.  These functions are generally quicker and more flexible than those from the USEPA Water Quality Portal.  The `util_importwqwa()` function retrieves metadata on the available information from the Water Atlas API.  This includes information on available data sources, parameters, sampling stations, and waterbodies.
+
+```{r}
+# data sources
+util_importwqwa('dataSources')
+
+# parameters
+util_importwqwa('parameters')
+
+# stations, using optional waterbodyId argument for Hillsborough Bay
+util_importwqwa('sampling-locations', waterbodyId = 20005)
+
+# waterbodies
+util_importwqwa('waterbodies')
+```
+
+The `read_importwqwa()` function retrieves the actual water quality data based on inputs for the data source, parameter, and date ranges.  The following shows how to import chlorophyll data (uncorrected) from Pinellas County for January of 2023. Consult the metadata using `util_importwqwa()` to determine available data sources and parameters.
+
+```{r}
+read_importwqwa(dataSource = 'WIN_21FLPDEM', parameter = 'Chla_ugl', 
+  start_date = '2023-01-01', end_date = '2023-01-31')
+```
+
 ## Analyze {.tabset}
 
 The functions `anlz_avedat()` and `anlz_avedatsite()` summarize the station data by bay segments or by sites, respectively.  Both functions return annual means for chlorophyll and light attenuation (based on Secchi depth measurements) and monthly means by year for chlorophyll and light attenuation.  These summaries are then used to determine if bay segment targets for water quality are met using the `anlz_attain()` and `anlz_attainsite()` function.