Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Call to action #742

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ 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).

# Call for volunteers

We are recruiting volunteers to participate in user testing of dataRetrieval, the goal being to ensure that we continue to meet users' needs and find areas for improvement.

For over ten years, the USGS has developed and maintained the R package dataRetrieval, which is designed to provide easy programmatic access to USGS water data. Over the next year we will be implementing updates to the package functionality as part of a larger effort to modernize USGS APIs and web services. Part of successfully ensuring these functionality updates meet the needs of our users involves user-centered design, which is why we're reaching out to you.

We are looking for R users at any experience level with dataRetrieval - from beginner to seasoned expert - and using dataRetrieval with any size data sets - from small, targeted data pulls to large and complex automated workflows. We are particularly interested in hearing from users who are pulling data using NWIS functions, such as readNWISdata, whatNWISdata, etc.

Participation in user testing will take about an hour. We will ask a set of questions to better understand how you use dataRetrieval and why, and we will ask users to walk us through a pre-determined coding example with dataRetrieval. Interviews will take place in February. There are no right or wrong answers - think of it as you’re testing us! We'll use your feedback to improve the usability and functionality of dataRetrieval and its user resources.

Please email CompTools@usgs.gov by January 28, 2025 if you are interested in participating, and please share this invitation with others who might also be interested. We will start contacting people in early February to schedule interviews.

# Introduction

: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>

:warning: All documentation on <https://doi-usgs.github.io/dataRetrieval> assume you have the development version of dataRetrieval installed. To do that:
Expand Down
64 changes: 50 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# dataRetrieval
# dataRetrieval <img src="man/figures/hex_logo.png" class="logo" alt="dataRetrieval" style="width:90px;height:auto;" align="right" />

[![CRAN
version](http://www.r-pkg.org/badges/version/dataRetrieval)](https://cran.r-project.org/package=EGRET)
Expand All @@ -14,6 +14,42 @@ 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).

# Call for volunteers

We are recruiting volunteers to participate in user testing of
dataRetrieval, the goal being to ensure that we continue to meet users’
needs and find areas for improvement.

For over ten years, the USGS has developed and maintained the R package
dataRetrieval, which is designed to provide easy programmatic access to
USGS water data. Over the next year we will be implementing updates to
the package functionality as part of a larger effort to modernize USGS
APIs and web services. Part of successfully ensuring these functionality
updates meet the needs of our users involves user-centered design, which
is why we’re reaching out to you.

We are looking for R users at any experience level with dataRetrieval -
from beginner to seasoned expert - and using dataRetrieval with any size
data sets - from small, targeted data pulls to large and complex
automated workflows. We are particularly interested in hearing from
users who are pulling data using NWIS functions, such as readNWISdata,
whatNWISdata, etc.

Participation in user testing will take about an hour. We will ask a set
of questions to better understand how you use dataRetrieval and why, and
we will ask users to walk us through a pre-determined coding example
with dataRetrieval. Interviews will take place in February. There are no
right or wrong answers - think of it as you’re testing us! We’ll use
your feedback to improve the usability and functionality of
dataRetrieval and its user resources.

Please email <CompTools@usgs.gov> by January 28, 2025 if you are
interested in participating, and please share this invitation with
others who might also be interested. We will start contacting people in
early February to schedule interviews.

# Introduction

: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
Expand Down Expand Up @@ -132,19 +168,19 @@ dv <- readNWISdv("09010500", "00060")
NWIScitation <- create_NWIS_bib(dv)

NWIScitation
#> U.S. Geological Survey (2024). _National Water Information System data
#> U.S. Geological Survey (2025). _National Water Information System data
#> available on the World Wide Web (USGS Water Data for the Nation)_.
#> doi:10.5066/F7P55KJN <https://doi.org/10.5066/F7P55KJN>, Accessed Oct
#> 23, 2024,
#> <https://waterservices.usgs.gov/nwis/dv/?site=09010500&format=waterml,1.1&ParameterCd=00060&StatCd=00003&startDT=1851-01-01>.
#> doi:10.5066/F7P55KJN <https://doi.org/10.5066/F7P55KJN>, Accessed Jan
#> 15, 2025,
#> <https://waterservices.usgs.gov/nwis/dv/?site=09010500&format=waterml%2C1.1&ParameterCd=00060&StatCd=00003&startDT=1851-01-01>.
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 Oct 23, 2024},
#> year = {2024},
#> url = {https://waterservices.usgs.gov/nwis/dv/?site=09010500&format=waterml,1.1&ParameterCd=00060&StatCd=00003&startDT=1851-01-01},
#> note = {Accessed Jan 15, 2025},
#> year = {2025},
#> url = {https://waterservices.usgs.gov/nwis/dv/?site=09010500&format=waterml%2C1.1&ParameterCd=00060&StatCd=00003&startDT=1851-01-01},
#> }
```

Expand All @@ -164,18 +200,18 @@ SC <- readWQPqw(siteNumbers = "USGS-05288705",

WQPcitation <- create_WQP_bib(SC)
WQPcitation
#> National Water Quality Monitoring Council (2024). _Water Quality
#> National Water Quality Monitoring Council (2025). _Water Quality
#> Portal_. doi:10.5066/P9QRKUVJ <https://doi.org/10.5066/P9QRKUVJ>,
#> Accessed Oct 23, 2024,
#> <https://www.waterqualitydata.us/data/Result/search?siteid=USGS-05288705&pCode=00300&mimeType=csv>.
#> Accessed Jan 15, 2025,
#> <https://www.waterqualitydata.us/data/Result/search?siteid=USGS-05288705&count=no&pCode=00300&mimeType=csv>.
print(WQPcitation, style = "Bibtex")
#> @Manual{,
#> title = {Water Quality Portal},
#> author = {{National Water Quality Monitoring Council}},
#> doi = {10.5066/P9QRKUVJ},
#> note = {Accessed Oct 23, 2024},
#> year = {2024},
#> url = {https://www.waterqualitydata.us/data/Result/search?siteid=USGS-05288705&pCode=00300&mimeType=csv},
#> note = {Accessed Jan 15, 2025},
#> year = {2025},
#> url = {https://www.waterqualitydata.us/data/Result/search?siteid=USGS-05288705&count=no&pCode=00300&mimeType=csv},
#> }
```

Expand Down
Loading