Description Location information is basic information about the monitoring location including the name, identifier, agency responsible for data collection, and the date the location was established. It also includes information about the type of location, such as stream, lake, or groundwater, and geographic information about the location, such as state, county, latitude and longitude, and hydrologic unit code (HUC).
Usage
read_USGS_sites(
monitoring_location_id = NA_character_,
agency_code = NA_character_,
agency_name = NA_character_,
monitoring_location_number = NA_character_,
monitoring_location_name = NA_character_,
district_code = NA_character_,
country_code = NA_character_,
country_name = NA_character_,
state_code = NA_character_,
state_name = NA_character_,
county_code = NA_character_,
county_name = NA_character_,
minor_civil_division_code = NA_character_,
site_type_code = NA_character_,
site_type = NA_character_,
hydrologic_unit_code = NA_character_,
basin_code = NA_character_,
altitude = NA_character_,
altitude_accuracy = NA_character_,
altitude_method_code = NA_character_,
altitude_method_name = NA_character_,
vertical_datum = NA_character_,
vertical_datum_name = NA_character_,
horizontal_positional_accuracy_code = NA_character_,
horizontal_positional_accuracy = NA_character_,
horizontal_position_method_code = NA_character_,
horizontal_position_method_name = NA_character_,
original_horizontal_datum = NA_character_,
original_horizontal_datum_name = NA_character_,
drainage_area = NA_character_,
contributing_drainage_area = NA_character_,
time_zone_abbreviation = NA_character_,
uses_daylight_savings = NA_character_,
construction_date = NA_character_,
aquifer_code = NA_character_,
national_aquifer_code = NA_character_,
aquifer_type_code = NA_character_,
well_constructed_depth = NA_character_,
hole_constructed_depth = NA_character_,
depth_source_code = NA_character_,
properties = NA_character_,
bbox = NA,
limit = 10000,
crs = NA_character_,
skipGeometry = NA
)Arguments
- monitoring_location_id
A unique identifier representing a single monitoring location. This corresponds to the
idfield in themonitoring-locationsendpoint. Monitoring location IDs are created by combining the agency code of the agency responsible for the monitoring location (e.g. USGS) with the ID number of the monitoring location (e.g. 02238500), separated by a hyphen (e.g. USGS-02238500).- agency_code
The agency that is reporting the data. Agency codes are fixed values assigned by the National Water Information System (NWIS). A list of agency codes is available at this link.
- agency_name
The name of the agency that is reporting the data.
- monitoring_location_number
Each monitoring location in the USGS data base has a unique 8- to 15-digit identification number. Monitoring location numbers are assigned based on this logic.
- monitoring_location_name
This is the official name of the monitoring location in the database. For well information this can be a district-assigned local number.
- district_code
The Water Science Centers (WSCs) across the United States use the FIPS state code as the district code. In some case, monitoring locations and samples may be managed by a water science center that is adjacent to the state in which the monitoring location actually resides. For example a monitoring location may have a district code of 30 which translates to Montana, but the state code could be 56 for Wyoming because that is where the monitoring location actually is located.
- country_code
The code for the country in which the monitoring location is located.
- country_name
The name of the country in which the monitoring location is located.
- state_code
State code. A two-digit ANSI code (formerly FIPS code) as defined by the American National Standards Institute, to define States and equivalents. A three-digit ANSI code is used to define counties and county equivalents. A lookup table is available. The only countries with political subdivisions other than the US are Mexico and Canada. The Mexican states have US state codes ranging from 81-86 and Canadian provinces have state codes ranging from 90-98.
- state_name
The name of the state or state equivalent in which the monitoring location is located.
- county_code
The code for the county or county equivalent (parish, borough, etc.) in which the monitoring location is located. A list of codes is available.
- county_name
The name of the county or county equivalent (parish, borough, etc.) in which the monitoring location is located. A list of codes is available.
- minor_civil_division_code
Codes for primary governmental or administrative divisions of the county or county equivalent in which the monitoring location is located.
- site_type_code
A code describing the hydrologic setting of the monitoring location. A list of codes is available.
- site_type
A description of the hydrologic setting of the monitoring location. A list of codes is available.
- hydrologic_unit_code
The United States is divided and sub-divided into successively smaller hydrologic units which are classified into four levels: regions, sub-regions, accounting units, and cataloging units. The hydrologic units are arranged within each other, from the smallest (cataloging units) to the largest (regions). Each hydrologic unit is identified by a unique hydrologic unit code (HUC) consisting of two to eight digits based on the four levels of classification in the hydrologic unit system.
- basin_code
The Basin Code or "drainage basin code" is a two-digit code that further subdivides the 8-digit hydrologic-unit code. The drainage basin code is defined by the USGS State Office where the monitoring location is located.
- altitude
Altitude of the monitoring location referenced to the specified Vertical Datum.
- altitude_accuracy
Accuracy of the altitude, in feet. An accuracy of +/- 0.1 foot would be entered as “.1”. Many altitudes are interpolated from the contours on topographic maps; accuracies determined in this way are generally entered as one-half of the contour interval.
- altitude_method_code
Codes representing the method used to measure altitude. A list of codes is available.
- altitude_method_name
The name of the the method used to measure altitude. A list of codes is available.
- vertical_datum
The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available.
- vertical_datum_name
The datum used to determine altitude and vertical position at the monitoring location. A list of codes is available.
- horizontal_positional_accuracy_code
Indicates the accuracy of the latitude longitude values. A list of codes is available.
- horizontal_positional_accuracy
Indicates the accuracy of the latitude longitude values. A list of codes is available.
- horizontal_position_method_code
Indicates the method used to determine latitude longitude values. A list of codes is available.
- horizontal_position_method_name
Indicates the method used to determine latitude longitude values. A list of codes is available.
- original_horizontal_datum
Coordinates are published in EPSG:4326 / WGS84 / World Geodetic System 1984. This field indicates the original datum used to determine coordinates before they were converted. A list of codes is available.
- original_horizontal_datum_name
Coordinates are published in EPSG:4326 / WGS84 / World Geodetic System 1984. This field indicates the original datum used to determine coordinates before they were converted. A list of codes is available.
- drainage_area
The area enclosed by a topographic divide from which direct surface runoff from precipitation normally drains by gravity into the stream above that point.
- contributing_drainage_area
The contributing drainage area of a lake, stream, wetland, or estuary monitoring location, in square miles. This item should be present only if the contributing area is different from the total drainage area. This situation can occur when part of the drainage area consists of very porous soil or depressions that either allow all runoff to enter the groundwater or traps the water in ponds so that rainfall does not contribute to runoff. A transbasin diversion can also affect the total drainage area.
- time_zone_abbreviation
A short code describing the time zone used by a monitoring location.
- uses_daylight_savings
A flag indicating whether or not a monitoring location uses daylight savings.
- construction_date
Date the well was completed.
- aquifer_code
Local aquifers in the USGS water resources data base are identified by a geohydrologic unit code (a three-digit number related to the age of the formation, followed by a 4 or 5 character abbreviation for the geologic unit or aquifer name). Additional information is available at this link.
- national_aquifer_code
National aquifers are the principal aquifers or aquifer systems in the United States, defined as regionally extensive aquifers or aquifer systems that have the potential to be used as a source of potable water. Not all groundwater monitoring locations can be associated with a National Aquifer. Such monitoring locations will not be retrieved using this search criteria. A list of National aquifer codes and names is available.
- aquifer_type_code
Groundwater occurs in aquifers under two different conditions. Where water only partly fills an aquifer, the upper surface is free to rise and decline. These aquifers are referred to as unconfined (or water-table) aquifers. Where water completely fills an aquifer that is overlain by a confining bed, the aquifer is referred to as a confined (or artesian) aquifer. When a confined aquifer is penetrated by a well, the water level in the well will rise above the top of the aquifer (but not necessarily above land surface). Additional information is available at this link.
- well_constructed_depth
The depth of the finished well, in feet below land surface datum. Note: Not all groundwater monitoring locations have information on Well Depth. Such monitoring locations will not be retrieved using this search criteria.
- hole_constructed_depth
The total depth to which the hole is drilled, in feet below land surface datum. Note: Not all groundwater monitoring locations have information on Hole Depth. Such monitoring locations will not be retrieved using this search criteria.
- depth_source_code
A code indicating the source of water-level data. A list of codes is available.
- properties
The properties that should be included for each feature. The parameter value is a comma-separated list of property names. Available options are geometry, id, agency_code, agency_name, monitoring_location_number, monitoring_location_name, district_code, country_code, country_name, state_code, state_name, county_code, county_name, minor_civil_division_code, site_type_code, site_type, hydrologic_unit_code, basin_code, altitude, altitude_accuracy, altitude_method_code, altitude_method_name, vertical_datum, vertical_datum_name, horizontal_positional_accuracy_code, horizontal_positional_accuracy, horizontal_position_method_code, horizontal_position_method_name, original_horizontal_datum, original_horizontal_datum_name, drainage_area, contributing_drainage_area, time_zone_abbreviation, uses_daylight_savings, construction_date, aquifer_code, national_aquifer_code, aquifer_type_code, well_constructed_depth, hole_constructed_depth, depth_source_code
- bbox
Only features that have a geometry that intersects the bounding box are selected.The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth). Coordinates are assumed to be in crs 4326.
- limit
The optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted.
- crs
Indicates the coordinate reference system for the results.
- skipGeometry
This option can be used to skip response geometries for each feature. The returning object will be a data frame with no spatial information.
Examples
# \donttest{
site <- "USGS-02238500"
site_info <- read_USGS_sites(monitoring_location_id = site)
#> Function in development, use at your own risk.
#> GET: https://api.waterdata.usgs.gov/ogcapi/v0/collections/monitoring-locations/items?f=json&lang=en-US&limit=10000&id=USGS-02238500
#> Remaining requests this hour:
site_slim <- read_USGS_sites(monitoring_location_id = site,
properties = c("monitoring_locations_id",
"state_name",
"country_name"))
#> Function in development, use at your own risk.
#> GET: https://api.waterdata.usgs.gov/ogcapi/v0/collections/monitoring-locations/items?f=json&lang=en-US&limit=10000&properties=state_name%2Ccountry_name&id=USGS-02238500
#> Remaining requests this hour:
site_info_no_sf <- read_USGS_sites(monitoring_location_id = site,
skipGeometry = TRUE)
#> Function in development, use at your own risk.
#> GET: https://api.waterdata.usgs.gov/ogcapi/v0/collections/monitoring-locations/items?f=json&lang=en-US&skipGeometry=TRUE&limit=10000&id=USGS-02238500
#> Remaining requests this hour:
multi_site <- read_USGS_sites(state_name = "Wisconsin")
#> Function in development, use at your own risk.
#> GET: https://api.waterdata.usgs.gov/ogcapi/v0/collections/monitoring-locations/items?f=json&lang=en-US&limit=10000&state_name=Wisconsin
#> Remaining requests this hour:
#> GET: https://api.waterdata.usgs.gov/ogcapi/v0/collections/monitoring-locations/items?offset=10000&lang=en-US&limit=10000&state_name=Wisconsin
#> Remaining requests this hour:
#> GET: https://api.waterdata.usgs.gov/ogcapi/v0/collections/monitoring-locations/items?offset=20000&lang=en-US&limit=10000&state_name=Wisconsin
#> Remaining requests this hour:
# }