From 122c064310fd4b0e0163a912ac88b9170a593dff Mon Sep 17 00:00:00 2001 From: Laura A DeCicco Date: Mon, 10 Jun 2024 10:40:00 -0500 Subject: [PATCH 1/3] First pass at updating readme --- README.Rmd | 24 ++++++++++++++++---- README.md | 65 +++++++++++++++++++++++++++++++++++++----------------- 2 files changed, 65 insertions(+), 24 deletions(-) diff --git a/README.Rmd b/README.Rmd index 2e970c1d..f9ff32bb 100644 --- a/README.Rmd +++ b/README.Rmd @@ -29,7 +29,26 @@ library(dataRetrieval) The `dataRetrieval` package was created to simplify the process of loading hydrologic data into the R environment. It is designed to retrieve the major data types of U.S. Geological Survey (USGS) hydrology data that are available on the Web, as well as data from the Water Quality Portal (WQP), which currently houses water quality data from the Environmental Protection Agency (EPA), U.S. Department of Agriculture (USDA), and USGS. Direct USGS data is obtained from a service called the National Water Information System (NWIS). -For complete tutorial information, see: +:warning: USGS discrete water-quality data availability and format are changing. Beginning March 11, 2024 USGS data obtained from legacy services will not include new USGS data or recent updates to existing data. To view the status of changes in data availability and code functionality, visit: https://doi-usgs.github.io/dataRetrieval/articles/Status.html + +If you have additional questions about these changes, email CompTools@usgs.gov. + +# What would you like to do? + +1. Get instantaneous USGS discharge data. [Start here](reference/readNWISuv.html) + +2. Get daily USGS discharge data. [Start here](reference/readNWISdv.html) + +3. Get USGS groundwater data. [Start here](reference/readNWISgwl.html) + +4. Get discrete water quality data. [Start here](reference/readWQPdata.html) + +4. Discover USGS data (not including discrete water quality data). [Start here](reference/whatNWISdata.html) + +6. Discover discrete water quality data. [Start here](reference/readWQPsummary.html) + + +For additional tutorials, see: [https://doi-usgs.github.io/dataRetrieval/](https://doi-usgs.github.io/dataRetrieval/) @@ -39,9 +58,6 @@ For complete tutorial information, see: [dataRetrieval Introduction 2](https://rconnect.usgs.gov/NMC_dataRetrieval_2) -:warning: USGS discrete water-quality data availability and format are changing. Beginning in mid-March 2024 the data obtained from legacy profiles will not include new USGS data or recent updates to existing data. To view the status of changes in data availability and code functionality, visit: https://doi-usgs.github.io/dataRetrieval/articles/Status.html - -If you have additional questions about these changes, email CompTools@usgs.gov. # Sample Workflow diff --git a/README.md b/README.md index 3ba60945..97efa138 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,36 @@ Environmental Protection Agency (EPA), U.S. Department of Agriculture (USDA), and USGS. Direct USGS data is obtained from a service called the National Water Information System (NWIS). -For complete tutorial information, see: +:warning: USGS discrete water-quality data availability and format are +changing. Beginning March 11, 2024 USGS data obtained from legacy +services will not include new USGS data or recent updates to existing +data. To view the status of changes in data availability and code +functionality, visit: + + +If you have additional questions about these changes, email +. + +# What would you like to do? + +1. Get instantaneous USGS discharge data. [Start + here](reference/readNWISuv.html) + +2. Get daily USGS discharge data. [Start + here](reference/readNWISdv.html) + +3. Get USGS groundwater data. [Start here](reference/readNWISgwl.html) + +4. Get discrete water quality data. [Start + here](reference/readWQPdata.html) + +5. Discover USGS data (not including discrete water quality data). + [Start here](reference/whatNWISdata.html) + +6. Discover discrete water quality data. [Start + here](reference/readWQPsummary.html) + +For additional tutorials, see: @@ -26,16 +55,6 @@ For complete tutorial information, see: [dataRetrieval Introduction 2](https://rconnect.usgs.gov/NMC_dataRetrieval_2) -:warning: USGS discrete water-quality data availability and format are -changing. Beginning in mid-March 2024 the data obtained from legacy -profiles will not include new USGS data or recent updates to existing -data. To view the status of changes in data availability and code -functionality, visit: - - -If you have additional questions about these changes, email -. - # Sample Workflow ## USGS @@ -148,15 +167,18 @@ NWIScitation <- create_NWIS_bib(dv) NWIScitation #> U.S. Geological Survey (2024). _National Water Information System data #> available on the World Wide Web (USGS Water Data for the Nation)_. -#> doi:10.5066/F7P55KJN , Accessed Feb -#> 20, 2024, +#> doi:10.5066/F7P55KJN , Accessed Jun +#> 10, 2024, #> . +``` + +``` r print(NWIScitation, style = "Bibtex") #> @Manual{, #> title = {National Water Information System data available on the World Wide Web (USGS Water Data for the Nation)}, #> author = {{U.S. Geological Survey}}, #> doi = {10.5066/F7P55KJN}, -#> note = {Accessed Feb 20, 2024}, +#> note = {Accessed Jun 10, 2024}, #> year = {2024}, #> url = {https://waterservices.usgs.gov/nwis/dv/?site=09010500&format=waterml,1.1&ParameterCd=00060&StatCd=00003&startDT=1851-01-01}, #> } @@ -178,18 +200,21 @@ SC <- readWQPqw(siteNumbers = "USGS-05288705", WQPcitation <- create_WQP_bib(SC) WQPcitation -#> National Water Quality Monitoring Council (2024). _ Water Quality +#> National Water Quality Monitoring Council (2024). _Water Quality #> Portal_. doi:10.5066/P9QRKUVJ , -#> Accessed Feb 20, 2024, -#> . +#> Accessed Jun 10, 2024, +#> . +``` + +``` r print(WQPcitation, style = "Bibtex") #> @Manual{, -#> title = { Water Quality Portal}, +#> title = {Water Quality Portal}, #> author = {{National Water Quality Monitoring Council}}, #> doi = {10.5066/P9QRKUVJ}, -#> note = {Accessed Feb 20, 2024}, +#> note = {Accessed Jun 10, 2024}, #> year = {2024}, -#> url = {https://www.waterqualitydata.us/data/Result/search?siteid=USGS-05288705&pCode=00300&mimeType=tsv&zip=yes}, +#> url = {https://www.waterqualitydata.us/wqx3/Result/search?siteid=USGS-05288705&pCode=00300&mimeType=csv&dataProfile=narrow}, #> } ``` From d0d362e9eab9a1af3389ce19e1750f03e3ba5f30 Mon Sep 17 00:00:00 2001 From: Laura A DeCicco Date: Mon, 10 Jun 2024 11:48:56 -0500 Subject: [PATCH 2/3] test formatting --- README.Rmd | 2 +- README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.Rmd b/README.Rmd index f9ff32bb..0766342f 100644 --- a/README.Rmd +++ b/README.Rmd @@ -41,7 +41,7 @@ If you have additional questions about these changes, email CompTools@usgs.gov. 3. Get USGS groundwater data. [Start here](reference/readNWISgwl.html) -4. Get discrete water quality data. [Start here](reference/readWQPdata.html) +4. Get discrete water quality data. Start here[`?readWQPdata`](reference/readWQPdata.html) 4. Discover USGS data (not including discrete water quality data). [Start here](reference/whatNWISdata.html) diff --git a/README.md b/README.md index 97efa138..621ef6d5 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,8 @@ If you have additional questions about these changes, email 3. Get USGS groundwater data. [Start here](reference/readNWISgwl.html) -4. Get discrete water quality data. [Start - here](reference/readWQPdata.html) +4. Get discrete water quality data. Start + here[`?readWQPdata`](reference/readWQPdata.html) 5. Discover USGS data (not including discrete water quality data). [Start here](reference/whatNWISdata.html) From aafbd19a38739e5f0f659d8cdf4530d5542d0f07 Mon Sep 17 00:00:00 2001 From: Laura A DeCicco Date: Mon, 10 Jun 2024 12:15:18 -0500 Subject: [PATCH 3/3] Better links --- README.Rmd | 17 +++++++---------- README.md | 21 ++++++++------------- 2 files changed, 15 insertions(+), 23 deletions(-) diff --git a/README.Rmd b/README.Rmd index 0766342f..f7bb25d9 100644 --- a/README.Rmd +++ b/README.Rmd @@ -35,24 +35,21 @@ If you have additional questions about these changes, email CompTools@usgs.gov. # What would you like to do? -1. Get instantaneous USGS discharge data. [Start here](reference/readNWISuv.html) +1. Get instantaneous USGS discharge data. Start here: `?readNWISuv` -2. Get daily USGS discharge data. [Start here](reference/readNWISdv.html) +2. Get daily USGS discharge data. Start here: `?readNWISdv` -3. Get USGS groundwater data. [Start here](reference/readNWISgwl.html) +3. Get USGS groundwater data. Start here: `?readNWISgwl` -4. Get discrete water quality data. Start here[`?readWQPdata`](reference/readWQPdata.html) +4. Get discrete water quality data. Start here: `?readWQPdata` -4. Discover USGS data (not including discrete water quality data). [Start here](reference/whatNWISdata.html) - -6. Discover discrete water quality data. [Start here](reference/readWQPsummary.html) +4. Discover USGS data (not including discrete water quality data). Start here: `?whatNWISdata` +6. Discover discrete water quality data. Start here: `?readWQPsummary` For additional tutorials, see: -[https://doi-usgs.github.io/dataRetrieval/](https://doi-usgs.github.io/dataRetrieval/) - -[https://waterdata.usgs.gov/blog/dataretrieval/](https://waterdata.usgs.gov/blog/dataretrieval/) +[Basic Tutorial](https://doi-usgs.github.io/dataRetrieval/articles/tutorial.html) [dataRetrieval Introduction 1](https://rconnect.usgs.gov/NMC_dataRetrieval_1) diff --git a/README.md b/README.md index 621ef6d5..20998239 100644 --- a/README.md +++ b/README.md @@ -26,28 +26,23 @@ If you have additional questions about these changes, email # What would you like to do? -1. Get instantaneous USGS discharge data. [Start - here](reference/readNWISuv.html) +1. Get instantaneous USGS discharge data. Start here: `?readNWISuv` -2. Get daily USGS discharge data. [Start - here](reference/readNWISdv.html) +2. Get daily USGS discharge data. Start here: `?readNWISdv` -3. Get USGS groundwater data. [Start here](reference/readNWISgwl.html) +3. Get USGS groundwater data. Start here: `?readNWISgwl` -4. Get discrete water quality data. Start - here[`?readWQPdata`](reference/readWQPdata.html) +4. Get discrete water quality data. Start here: `?readWQPdata` 5. Discover USGS data (not including discrete water quality data). - [Start here](reference/whatNWISdata.html) + Start here: `?whatNWISdata` -6. Discover discrete water quality data. [Start - here](reference/readWQPsummary.html) +6. Discover discrete water quality data. Start here: `?readWQPsummary` For additional tutorials, see: - - - +[Basic +Tutorial](https://doi-usgs.github.io/dataRetrieval/articles/tutorial.html) [dataRetrieval Introduction 1](https://rconnect.usgs.gov/NMC_dataRetrieval_1)