Generalized USGS Water Meta Data API retrieval function — read_waterdata

Function to get metadata from Water Data API. These are useful to get the human readable words and other metadata associated with USGS codes.

Usage

read_waterdata_metadata(
  collection,
  ...,
  limit = getOption("dataRetrieval.limit"),
  attach_request = getOption("dataRetrieval.attach_request")
)

Arguments

collection: character, can be any existing collection such as "parameter-codes", "agency-codes", "altitude-datums", "aquifer-codes", "aquifer-types", "coordinate-accuracy-codes", "coordinate-datum-codes", "coordinate-method-codes", "hydrologic-unit-codes", "medium-codes", "national-aquifer-codes", "reliability-codes", "site-types", "statistic-codes", "topographic-codes", "time-zone-codes".
...: Optional arguments to pass to the query. Available parameters can be found with the get_ogc_params function.
limit: The optional limit parameter is used to control the subset of the selected features that should be returned in each page. The maximum allowable limit is 50000. It may be beneficial to set this number lower if your internet connection is spotty. The default (NA) will set the limit to the maximum allowable limit for the service.
attach_request: logical, defaults to TRUE. If set to TRUE, the full request sent to the Water Data API is attached as an attribute to the data set.

Examples


# \donttest{
agency_codes <- read_waterdata_metadata("agency-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/agency-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2575 
altitude_datums <- read_waterdata_metadata("altitude-datums")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/altitude-datums/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2574 
aquifer_codes <- read_waterdata_metadata("aquifer-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/aquifer-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2573 
aquifer_types <- read_waterdata_metadata("aquifer-types")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/aquifer-types/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2572 
counties <- read_waterdata_metadata("counties")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/counties/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2571 
countries <- read_waterdata_metadata("countries")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/countries/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2570 
us_counties <- read_waterdata_metadata("counties", country_code = "US")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/counties/items?f=json&lang=en-US&country_code=US&limit=50000
#> Remaining requests this hour:2570 
coordinate_accuracy_codes <- read_waterdata_metadata("coordinate-accuracy-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-accuracy-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2567 
coordinate_datum_codes <- read_waterdata_metadata("coordinate-datum-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-datum-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2567 
coordinate_method_codes <- read_waterdata_metadata("coordinate-method-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/coordinate-method-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2567 
huc_codes <- read_waterdata_metadata("hydrologic-unit-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/hydrologic-unit-codes/items?f=json&lang=en-US&limit=50000
#> ⠙ iterating 1 done (0.42/s) | 2.4s
#> Remaining requests this hour:2567 
#> Remaining requests this hour:2563 
#> ⠹ iterating 3 done (0.72/s) | 4.2s
#> Remaining requests this hour:2562 
methods <- read_waterdata_metadata("methods")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/methods/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2561 
method_categories <- read_waterdata_metadata("method-categories")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/method-categories/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2560 
method_citations <- read_waterdata_metadata("method-citations")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/method-citations/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2559 
citations <- read_waterdata_metadata("citations")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/citations/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2558 
national_aquifer_codes <- read_waterdata_metadata("national-aquifer-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/national-aquifer-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2558 
parameter_codes <- read_waterdata_metadata("parameter-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/parameter-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2557 
reliability_codes <- read_waterdata_metadata("reliability-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/reliability-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2555 
site_types <- read_waterdata_metadata("site-types")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/site-types/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2554 
states <- read_waterdata_metadata("states")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/states/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2553 
us_states_territories <- read_waterdata_metadata("states", country_code = "US")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/states/items?f=json&lang=en-US&country_code=US&limit=50000
#> Remaining requests this hour:2551 
statistic_codes <- read_waterdata_metadata("statistic-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/statistic-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2550 
topographic_codes <- read_waterdata_metadata("topographic-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/topographic-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2549 
time_zone_codes <- read_waterdata_metadata("time-zone-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/time-zone-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2548 
time_zone_limited <- read_waterdata_metadata("time-zone-codes",
                        time_zone_description = c("Alaska", "Hawaii", "Pacific North America"))
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v1/collections/time-zone-codes/items?f=json&lang=en-US&limit=50000
#> Remaining requests this hour:2548 
# }