robbriers / hddtools

Hydrological Data Discovery Tools (R package for hydrology and open data)

hddtools: Hydrological Data Discovery Tools

hddtools stands for Hydrological Data Discovery Tools. This R package is an open source project designed to facilitate access to a variety of online open data sources relevant for hydrologists and, in general, environmental scientists and practitioners.

This typically implies the download of a metadata catalogue, selection of information needed, a formal request for dataset(s), de-compression, conversion, manual filtering and parsing. All those operations are made more efficient by re-usable functions.

Depending on the data license, functions can provide offline and/or online modes. When redistribution is allowed, for instance, a copy of the dataset is cached within the package and updated twice a year. This is the fastest option and also allows offline use of package's functions. When re-distribution is not allowed, only online mode is provided.

Dependencies & Installation

The hddtools package depends on other CRAN packages. Check for missing dependencies and install them using the commands below:

packs <- c("zoo", "sp", "RCurl", "XML", "rnrfa", "Hmisc", "raster", 
           "stringr", "devtools", "leaflet")
new_packages <- packs[!(packs %in% installed.packages()[,"Package"])]
if(length(new_packages)) install.packages(new_packages)

Get the released version from CRAN:

install.packages("hddtools")

Or the development version from github using devtools:

devtools::install_github("ropensci/hddtools")

Load the hddtools package:

library("hddtools")

Data sources and Functions

The package contains functions to interact with the data providers listed below. For examples of the various functionalities see the vignette.

• KGClimateClass: 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: The Global Runoff Data Centre (GRDC) provides datasets for all the major rivers in the world.

• TRMM: The NASA's Tropical Rainfall Measuring Mission records global historical rainfall estimation in a gridded format since 1998 with a daily temporal resolution and a spatial resolution of 0.25 degrees. Please note the TRMM function has been temporarily removed from hddtools v0.7 as the ftp at NASA containing the data has been migrated. A new function is under development and will be avalable at the next release (v0.8).

• Data60UK: The Data60UK initiative collated datasets of areal precipitation and streamflow discharge across 61 gauging sites in England and Wales (UK).

• MOPEX: This dataset contains historical hydrometeorological data and river basin characteristics for hundreds of river basins in the US.

• SEPA: The Scottish Environment Protection Agency (SEPA) provides river level data for hundreds of gauging stations in the UK.

Meta

• This package and functions herein are part of an experimental open-source project. They are provided as is, without any guarantee.
• Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
• Please report any issues or bugs.
• License: GPL-3
• This package was reviewed by Erin Le Dell and Michael Sumner for submission to ROpenSci (see review here) and the Journal of Open Source Software (see review status here).
• Get citation information for hddtools in R doing citation(package = "hddtools")