Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ropensci/hddtools

Hydrological Data Discovery Tools (R package for hydrology and open data)
https://github.com/ropensci/hddtools

data60uk grdc hydrology kgclimateclass mopex peer-reviewed precipitation r r-package rstats sepa

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README

        

# hddtools: Hydrological Data Discovery Tools

[![DOI](https://zenodo.org/badge/22423032.svg)](https://zenodo.org/badge/latestdoi/22423032)
[![status](https://joss.theoj.org/papers/10.21105/joss.00056/status.svg)](https://joss.theoj.org/papers/10.21105/joss.00056)

[![CRAN Status
Badge](http://www.r-pkg.org/badges/version/hddtools)](https://cran.r-project.org/package=hddtools)
[![CRAN Total
Downloads](http://cranlogs.r-pkg.org/badges/grand-total/hddtools)](https://cran.r-project.org/package=hddtools)
[![CRAN Monthly
Downloads](http://cranlogs.r-pkg.org/badges/hddtools)](https://cran.r-project.org/package=hddtools)

[![R-CMD-check](https://github.com/ropensci/hddtools/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/hddtools/actions)
[![codecov.io](https://codecov.io/github/ropensci/hddtools/coverage.svg?branch=master)](https://codecov.io/github/ropensci/hddtools?branch=master)
[![](https://badges.ropensci.org/73_status.svg)](https://github.com/ropensci/software-review/issues/73)

`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:

``` r
install.packages("hddtools")
```

Or the development version from GitHub using the package `remotes`:

``` r
install.packages("remotes")
remotes::install_github("ropensci/hddtools")
```

Load the `hddtools` package:

``` r
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](https://github.com/ropensci/hddtools/blob/master/vignettes/hddtools_vignette.Rmd).

- [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/): 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](http://tdwg.catchment.org/datasets.html): 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.

## 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](https://github.com/ropensci/hddtools/blob/master/CONDUCT.md).
By participating in this project you agree to abide by its terms.
- Please [report any issues or bugs](https://github.com/ropensci/hddtools/issues).
- License: [GPL-3](https://opensource.org/licenses/GPL-3.0)
- This package was reviewed by [Erin Le
Dell](https://github.com/ledell) and [Michael
Sumner](https://github.com/mdsumner) for submission to ROpenSci (see
review [here](https://github.com/ropensci/software-review/issues/73)) and
the Journal of Open Source Software (see review status
[here](https://github.com/openjournals/joss-reviews/issues/56)).
- Cite `hddtools`: `citation(package = "rdefra")`


[![ropensci\_footer](https://ropensci.org/public_images/github_footer.png)](https://ropensci.org)