readNWISdata with peak service

[ldecicco-USGS]

I would expect this to work:

peaks <- readNWISdata(stateCd="PA", service="peak")

But, you need this instead:

peaks <- readNWISdata(stateCd="PA", service="peak",
                      list_of_search_criteria="state_cd")

We should check state, county, and HUC queries and make sure the peak requests act similar to the other services.

[ldecicco-USGS]

url <- "https://nwis.waterdata.usgs.gov/nwis/peak?state_cd=pa&group_key=county_cd&sitefile_output_format=html_table&column_name=agency_cd&column_name=site_no&column_name=station_nm&set_logscale_y=1&format=rdb&date_format=YYYY-MM-DD&rdb_compression=value&hn2_compression=file&list_of_search_criteria=state_cd"

x <- importRDB1(url)

[ldecicco-USGS]

Generally, the readNWISdata function requires the user to be pretty savvy with understanding how to call their data. However, when we can make their lives a little easier we try.

The question here is for the peak service: https://nwis.waterdata.usgs.gov/nwis/peak

So, right now, for the user to get peak data for a single state, they need to do this:

x2 <- readNWISdata(state_cd = "PA",
                   list_of_search_criteria="state_cd", 
                   service = "peak")

If you don't add that list_of_search_criteria="state_cd",, you get the whole country.

What we could do is add another check here. Somewhere in readNWISdots we could add:

    if (service == "peak" & "state_cd" %in% names(values)){
       values["list_of_search_criteria"] <- "state_cd"
    }

Then we'd want to add an example to the readNWISdata helpfile that looks like this:

pa_peaks <- readNWISdata(state_cd = "PA",
                   service = "peak")

We should then also add that as a test in the testthat folder.

So, things to do:

• [x] Update readNWISdots so users don't need to add list_of_search_criteria for state_cd
• [x] Check county codes, HUC code, boundary boxes....do they need list_of_search_criteria values too?
• [x] Add an example (or 2 if needed) to the roxygen help file
• [ ] Add a test to https://github.com/USGS-R/dataRetrieval/blob/main/tests/testthat/tests_general.R
• [ ] Update package version in the DESCRIPTION file (to 2.7.11.2...before we'd send anything to CRAN we'll set it to 2.7.12)
• [ ] Add a short blurb to the NEWS file