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

Edits to status Rmd page #735

Merged
merged 4 commits into from
Oct 25, 2024
Merged

Conversation

ehinman
Copy link
Contributor

@ehinman ehinman commented Oct 25, 2024

This PR updates the status page to include information about the retirement of readNWISqw() and the WQP functions default to WQX version 2.


When the NWIS services are decommissioned (possible September 2024): there will no longer be any "qw" information provided in the output of `whatNWISdata`. Discrete water-quality availability will be available via WQP services. More information will be provided as we learn more.
When the NWIS services are decommissioned (likely in 2025): there will no longer be any "qw" information provided in the output of `whatNWISdata`. Discrete water-quality availability will be available via WQP services. More information will be provided as we learn more.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I think this is incorrect. I'm wondering if whatNWISdata still returns older qw data, or if the service HAS been decommissioned.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just looking at this. It's still showing qw data, but I'll try to get clarification on what will happen when the NWIS qw service actually gets decommissioned

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

qwdata isn't slated for decommission until end of Q1, so it should still be working. Another tact for this warning is to just say that the 'qw' information has not been updated since March 2024 and will soon become deprecated: we recommend users obtain water quality data availability from the WQP services instead. Or something

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, but will there be any qw info from the site inventory after Q1, or will there always be the stale info?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if that info is being pulled from an rdb then yes, that info will no longer be available. IoW will not support a public endpoint for data in the qwdata DB indefinitely, at some point it will be decommissioned.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That info is coming from the site service (which is waterservices, not waterdata) - but it is RDB. So something like:

https://waterservices.usgs.gov/nwis/site/?seriesCatalogOutput=true&sites=385032115220501,391133115264801&format=rdb

I'm guessing (and hoping!) that the qw data just goes away because it would be much more confusing to be wrong/outdated. But I'm still not clear if we know that anwer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the data should stop flowing when qwdata is decommissioned.

@@ -73,7 +73,7 @@ knitr::kable(df)

This function is generally advertised as a user-friendly function since it only works with a known list of sites, parameter codes or characterisitic names, and start/end dates.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see where 'this function' is defined, assuming it is readWQPqw()?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's under the header ## readWQPqw (on line 72). We can change it though to:

The readWQPqw function is generally advertised...

@@ -97,11 +97,11 @@ attr(rawPcode_legacy, "url")

## readWQPdata

The "readWQPdata" function is the most flexible function to get WQP data. Currently there are 4 options that use the new WQX 3.0 profiles, and 11 legacy options.
The `readWQPdata()` function is the most flexible function to get WQP data. Currently there are 11 legacy options and 4 options that use the new WQX 3.0 profiles. Note that `readWQPdata()` does not leverage a `legacy` argument to specify which profile version the user would like returned, but instead relies on the user's specification of `service` and `dataProfile` arguments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correction: there are 5 WQX3 profiles

@ldecicco-USGS ldecicco-USGS merged commit 062e50c into DOI-USGS:main Oct 25, 2024
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants