| Title: | Hydrological Data Discovery Tools |
|---|---|
| Description: | Tools to discover hydrological data, accessing catalogues and databases from various data providers. The package is described in Vitolo (2017) "hddtools: Hydrological Data Discovery Tools" <doi:10.21105/joss.00056>. |
| Authors: | Claudia Vitolo [aut]  ,
Wouter Buytaert [ctb] (Supervisor),
Erin Le Dell [ctb] (Erin reviewed the package for rOpenSci, see
https://github.com/ropensci/software-review/issues/73),
Michael Sumner [ctb] (Michael reviewed the package for rOpenSci, see
https://github.com/ropensci/software-review/issues/73),
Dorothea Hug Peter [aut, cre] |
| Maintainer: | Dorothea Hug Peter <[email protected]> |
| License: | GPL-3 |
| Version: | 0.9.5 |
| Built: | 2024-09-02 10:17:01 UTC |
| Source: | https://github.com/ropensci/hddtools |
Convert a bounding box to a SpatialPolygons object Bounding box is first created (in lat/lon) then projected if specified
bboxSpatialPolygon(boundingbox, proj4stringFrom = NULL, proj4stringTo = NULL)bboxSpatialPolygon(boundingbox, proj4stringFrom = NULL, proj4stringTo = NULL)
boundingbox |
Bounding box: a 2x2 numerical matrix of lat/lon coordinates |
proj4stringFrom |
Projection string for the current boundingbox coordinates (defaults to lat/lon, WGS84) |
proj4stringTo |
Projection string, or NULL to not project |
A SpatialPolygons object of the bounding box
https://gis.stackexchange.com/questions/46954/clip-spatial-object-to-bounding-box-in-r
## Not run: boundingbox <- terra::ext(-180, +180, -50, +50) bbSP <- bboxSpatialPolygon(boundingbox = boundingbox) ## End(Not run)## Not run: boundingbox <- terra::ext(-180, +180, -50, +50) bbSP <- bboxSpatialPolygon(boundingbox = boundingbox) ## End(Not run)
This function interfaces the Data60UK database catalogue listing 61 gauging stations.
catalogueData60UK(areaBox = NULL)catalogueData60UK(areaBox = NULL)
areaBox |
bounding box, a list made of 4 elements: minimum longitude (lonMin), minimum latitude (latMin), maximum longitude (lonMax), maximum latitude (latMax) or an object of type "SpatExtent" |
This function returns a data frame containing the following columns:
idStation id number.
RiverString describing the river's name.
LocationString describing the location.
gridReferenceBritish National Grid Reference.
LatitudeLongitudeClaudia Vitolo
http://nrfaapps.ceh.ac.uk/datauk60/data.html
## Not run: # Retrieve the whole catalogue Data60UK_catalogue_all <- catalogueData60UK() # Filter the catalogue based on a bounding box areaBox <- terra::ext(-4, -2, +52, +53) Data60UK_catalogue_bbox <- catalogueData60UK(areaBox) ## End(Not run)## Not run: # Retrieve the whole catalogue Data60UK_catalogue_all <- catalogueData60UK() # Filter the catalogue based on a bounding box areaBox <- terra::ext(-4, -2, +52, +53) Data60UK_catalogue_bbox <- catalogueData60UK(areaBox) ## End(Not run)
This function interfaces the Global Runoff Data Centre database which provides river discharge data for almost 1000 sites over 157 countries.
catalogueGRDC()catalogueGRDC()
This function returns a data frame made with the following columns:
grdc_no: GRDC station number
wmo_reg: WMO region
sub_reg: WMO subregion
river: river name
station: station name
country: 2-letter country code (ISO 3166)
lat: latitude, decimal degree
long: longitude, decimal degree
area: catchment size, km2
altitude: height of gauge zero, m above sea level
d_start: daily data available from year
d_end: daily data available until year
d_yrs: length of time series, daily data
d_miss: percentage of missing values (daily data)
m_start: monthly data available from
m_end: monthly data available until
m_yrs: length of time series, monthly data
m_miss: percentage of missing values (monthly data)
t_start: earliest data available
t_end: latest data available
t_yrs: maximum length of time series, daily and monthly
data
lta_discharge: mean annual streamflow, m3/s
r_volume_yr: mean annual volume, km3
r_height_yr: mean annual runoff depth, mm
Claudia Vitolo
## Not run: # Retrieve the catalogue GRDC_catalogue_all <- catalogueGRDC() ## End(Not run)## Not run: # Retrieve the catalogue GRDC_catalogue_all <- catalogueGRDC() ## End(Not run)
This function retrieves the list of the MOPEX basins.
catalogueMOPEX(MAP = TRUE)catalogueMOPEX(MAP = TRUE)
MAP |
Boolean, TRUE by default. If FALSE it returns a list of the USGS station ID’s and the gage locations of all 1861 potential MOPEX basins. If TRUE, it return a list of the USGS station ID’s and the gage locations of the 438 MOPEX basins with MAP estimates. |
This function returns a data frame containing the following columns:
USGS_IDStation id number
LongitudeDecimal degrees East
LatitudeDecimal degrees North
Drainage_AreaSquare Miles
R_gaugesRequired number of precipitation gages to meet MAP accuracy criteria
N_gaugesNumber of gages in total gage window used to estimate MAP
A_gaugesAvaliable number of gages in the basin
Ratio_ARRatio of Available to Required number of gages in the basin
Date_startDate when recordings start
Date_endDate when recordings end
StateState of the basin
NameName of the basin
Columns Date_start, Date_end, State, Name are taken from:
https://hydrology.nws.noaa.gov/pub/gcip/mopex/US_Data/Basin_Characteristics/usgs431.txt
Date_start and Date_end are conventionally set to the first of the month
here, however actual recordings my differ. Always refer to the recording date
obtained as output of tsMOPEX().
Claudia Vitolo
https://hydrology.nws.noaa.gov/pub/gcip/mopex/US_Data/Documentation/
## Not run: # Retrieve the MOPEX catalogue catalogue <- catalogueMOPEX() ## End(Not run)## Not run: # Retrieve the MOPEX catalogue catalogue <- catalogueMOPEX() ## End(Not run)
This function provides the official SEPA database catalogue of river level data (from https://www2.sepa.org.uk/waterlevels/CSVs/SEPA_River_Levels_Web.csv) containing info for hundreds of stations. Some are NRFA stations. The function has no input arguments.
catalogueSEPA()catalogueSEPA()
This function returns a data frame containing the following columns:
SEPA_HYDROLOGY_OFFICESTATION_NAMELOCATION_CODEStation id number.
NATIONAL_GRID_REFERENCECATCHMENT_NAMERIVER_NAMEGAUGE_DATUMCATCHMENT_AREAin Km2
START_DATEEND_DATESYSTEM_IDLOWEST_VALUELOWMAX_VALUEHIGHMAX_DISPLAYMEANUNITSWEB_MESSAGENRFA_LINKClaudia Vitolo
## Not run: # Retrieve the whole catalogue SEPA_catalogue_all <- catalogueSEPA() ## End(Not run)## Not run: # Retrieve the whole catalogue SEPA_catalogue_all <- catalogueSEPA() ## End(Not run)
The grdcLTMMD look-up table
data("grdcLTMMD")data("grdcLTMMD")
A data frame with 6 rows and 4 columns.
WMO_Regionan integer between 1 and 6
CoverageNumber_of_stationsArchiveurl to spreadsheet
Many governmental bodies and institutions are currently committed to publish open data as the result of a trend of increasing transparency, based on which a wide variety of information produced at public expense is now becoming open and freely available to improve public involvement in the process of decision and policy making. Discovery, access and retrieval of information is, however, not always a simple task. Especially when access to data APIs is not allowed, downloading a metadata catalogue, selecting the information needed, requesting datasets, de-compression, conversion, manual filtering and parsing can become rather tedious. The R package hddtools is an open source project, designed to make all the above operations more efficient by means of reusable functions.
The package facilitate access to various online data sources such as:
KGClimateClass (http://koeppen-geiger.vu-wien.ac.at/): The Koppen Climate Classification map is used for classifying the world's climates based on the annual and monthly averages of temperature and precipitation
GRDC (http://www.bafg.de/GRDC/EN/Home/homepage_node.html): The Global Runoff Data Centre (GRDC) provides datasets for all the major rivers in the world
Data60UK (http://tdwg.catchment.org/datasets.html): The Data60UK initiative collated datasets of areal precipitation and streamflow discharge across 61 gauging sites in England and Wales (UK).
MOPEX (https://www.nws.noaa.gov/ohd/mopex/mo_datasets.htm): This dataset contains historical hydrometeorological data and river basin characteristics for hundreds of river basins in the US.
SEPA (https://www2.sepa.org.uk/WaterLevels/): The Scottish Environment Protection Agency (SEPA) provides river level data for hundreds of gauging stations in the UK.
This package complements R's growing functionality in environmental web technologies by bridging the gap between data providers and data consumers. It is designed to be an initial building block of scientific workflows for linking data and models in a seamless fashion.
Vitolo C, Buytaert W, 2014, HDDTOOLS: an R package serving Hydrological Data Discovery Tools, AGU Fall Meeting, 15-19 December 2014, San Francisco, USA.
Given a bounding box, the function identifies the overlapping climate zones.
KGClimateClass(areaBox = NULL, updatedBy = "Peel", verbose = FALSE)KGClimateClass(areaBox = NULL, updatedBy = "Peel", verbose = FALSE)
areaBox |
bounding box, a list made of 4 elements: minimum longitude (lonMin), minimum latitude (latMin), maximum longitude (lonMax), maximum latitude (latMax) |
updatedBy |
this can either be "Kottek" or "Peel" |
verbose |
if TRUE more info are printed on the screen |
List of overlapping climate zones.
Claudia Vitolo
Kottek et al. (2006): http://koeppen-geiger.vu-wien.ac.at/. Peel et al. (2007): https://people.eng.unimelb.edu.au/mpeel/koppen.html.
## Not run: # Define a bounding box areaBox <- terra::ext(-3.82, -3.63, 52.41, 52.52) # Get climate classes KGClimateClass(areaBox = areaBox) ## End(Not run)## Not run: # Define a bounding box areaBox <- terra::ext(-3.82, -3.63, 52.41, 52.52) # Get climate classes KGClimateClass(areaBox = areaBox) ## End(Not run)
This function extract the dataset containing daily rainfall and streamflow discharge at one of the Data60UK locations.
tsData60UK(id)tsData60UK(id)
id |
String which identifies the station ID number |
The function returns a data frame containing 2 time series (as zoo objects): "P" (precipitation) and "Q" (discharge).
Claudia Vitolo
## Not run: Morwick <- tsData60UK(id = "22001") ## End(Not run)## Not run: Morwick <- tsData60UK(id = "22001") ## End(Not run)
This function extract the dataset containing daily rainfall and streamflow discharge at one of the MOPEX locations.
tsMOPEX(id, MAP = TRUE)tsMOPEX(id, MAP = TRUE)
id |
String for the station ID number (USGS_ID) |
MAP |
Boolean, TRUE by default. If FALSE it looks for data through all the 1861 potential MOPEX basins. If TRUE, it looks for data through the 438 MOPEX basins with MAP estimates. |
If MAP = FALSE, this function returns a time series of daily streamflow discharge (Q, in mm). If MAP = TRUE, this function returns a data frame containing the following columns (as zoo object):
DateFormat is "yyyymmdd"
PMean areal precipitation (mm)
EClimatic potential evaporation (mm, based NOAA Freewater Evaporation Atlas)
QDaily streamflow discharge (mm)
T_maxDaily maximum air temperature (Celsius)
T_minDaily minimum air temperature (Celsius)
Claudia Vitolo
## Not run: BroadRiver <- tsMOPEX(id = "01048000") ## End(Not run)## Not run: BroadRiver <- tsMOPEX(id = "01048000") ## End(Not run)
This function extract the dataset containing daily rainfall and streamflow discharge at one of the MOPEX locations.
tsSEPA(id)tsSEPA(id)
id |
hydrometric reference number (string) |
The function returns river level data in metres, as a zoo object.
Claudia Vitolo
## Not run: sampleTS <- tsSEPA(id = "10048") ## End(Not run)## Not run: sampleTS <- tsSEPA(id = "10048") ## End(Not run)