R TeX
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
R Fixed column name in GRDCcatalogue Aug 9, 2018
data
inst pkgdown to parent folder Aug 9, 2018
man Fixed column name in GRDCcatalogue Aug 9, 2018
tests
vignettes Removed all the references to trmm Apr 13, 2018
.Rbuildignore Removed all the references to trmm Apr 13, 2018
.gitignore
.travis.yml added installation of hddtools to travis Aug 9, 2018
CONDUCT.md Updated to v0.3 Sep 5, 2016
DESCRIPTION updated r-lib/pkgdown Aug 8, 2018
NAMESPACE Release v0.7 - temporary removed TRMM Apr 2, 2017
NEWS.md
README.Rmd
README.md Removed all the references to trmm Apr 13, 2018
_pkgdown.yml pkgdown to parent folder Aug 9, 2018
appveyor.yml Removed oldrel from appveyor Dec 23, 2016
cran-comments.md

README.md

hddtools: Hydrological Data Discovery Tools

DOI status

CRAN Status Badge CRAN Total Downloads CRAN Monthly Downloads

Travis-CI Build Status AppVeyor Build Status codecov.io

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.

Installation

Get the stable 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.

  • 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")

ropensci_footer