Skip to content

Fix summarize_waterdata_samples doc claims that contradict the service #889

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.

Sign up for GitHub

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

Merged
ldecicco-USGS merged 1 commit into from
May 5, 2026
Merged

Fix summarize_waterdata_samples doc claims that contradict the service #889

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions R/read_waterdata_samples.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,10 +509,13 @@ read_waterdata_samples <- function(
#' This function creates the call and gets the data for discrete water quality samples summary data
#' service described at <https://api.waterdata.usgs.gov/samples-data/docs>.
#'
#' @param monitoringLocationIdentifier A monitoring location identifier has two parts,
#' separated by a dash (-): the agency code and the location number. Location identifiers should be separated with commas,
#' for example: AZ014-320821110580701, CAX01-15304600, USGS-040851385. Location
#' numbers without an agency prefix are assumed to have the prefix USGS.
#' @param monitoringLocationIdentifier A single monitoring location identifier
#' with two parts, separated by a dash (-): the agency code and the location
#' number. Examples: USGS-040851385, AZ014-320821110580701, CAX01-15304600.
#' The summary service accepts only one site at a time; supplying a vector of
#' length > 1 raises an error. The agency prefix is required: bare location
#' numbers (e.g. "040851385") are accepted by the service but return an empty
#' result.
#' @export
#' @return data frame with summary of data available based on the monitoringLocationIdentifier
#' @rdname summarize_waterdata_samples
Expand Down
Loading