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 = NA, ...)

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".
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.
...: Optional arguments to pass to the query. Available parameters can be found with the get_ogc_params function.

Examples


# \donttest{
agency_codes <- read_waterdata_metadata("agency-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/agency-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2958 
altitude_datums <- read_waterdata_metadata("altitude-datums")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/altitude-datums/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2960 
aquifer_codes <- read_waterdata_metadata("aquifer-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/aquifer-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2960 
aquifer_types <- read_waterdata_metadata("aquifer-types")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/aquifer-types/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2954 
counties <- read_waterdata_metadata("counties")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2952 
us_counties <- read_waterdata_metadata("counties", country_code = "US")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/counties/items?f=json&lang=en-US&skipGeometry=TRUE&country_code=US&limit=50000
#> Remaining requests this hour:2951 
coordinate_accuracy_codes <- read_waterdata_metadata("coordinate-accuracy-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-accuracy-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2952 
coordinate_datum_codes <- read_waterdata_metadata("coordinate-datum-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-datum-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2950 
coordinate_method_codes <- read_waterdata_metadata("coordinate-method-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/coordinate-method-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2949 
huc_codes <- read_waterdata_metadata("hydrologic-unit-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/hydrologic-unit-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2948 
#> Remaining requests this hour:2947 
#> Remaining requests this hour:2944 
national_aquifer_codes <- read_waterdata_metadata("national-aquifer-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/national-aquifer-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2942 
parameter_codes <- read_waterdata_metadata("parameter-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/parameter-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2942 
reliability_codes <- read_waterdata_metadata("reliability-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/reliability-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2940 
site_types <- read_waterdata_metadata("site-types")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/site-types/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2940 
states <- read_waterdata_metadata("states")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/states/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2939 
us_states_territories <- read_waterdata_metadata("states", country_code = "US")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/states/items?f=json&lang=en-US&skipGeometry=TRUE&country_code=US&limit=50000
#> Remaining requests this hour:2940 
statistic_codes <- read_waterdata_metadata("statistic-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/statistic-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2938 
topographic_codes <- read_waterdata_metadata("topographic-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/topographic-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2935 
time_zone_codes <- read_waterdata_metadata("time-zone-codes")
#> Requesting:
#> https://api.waterdata.usgs.gov/ogcapi/v0/collections/time-zone-codes/items?f=json&lang=en-US&skipGeometry=TRUE&limit=50000
#> Remaining requests this hour:2938 
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/v0/collections/time-zone-codes/items?f=json&lang=en-US&limit=50000&skipGeometry=TRUE
#> Remaining requests this hour:2935 
# }