# hydroDrought

**Repository Path**: dongyi1996/hydroDrought

## Basic Information

- **Project Name**: hydroDrought
- **Description**: Companion repository for textbook
- **Primary Language**: HTML
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-05-08
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Hydrological Drought Book

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.146.svg)](https://doi.org/10.5281/zenodo.146)

This repository contains code associated with the book, entitled, 'Hydrological Drought - Processes and estimation methods for streamflow and groundwater'. When run, it will replicate the results published in the book ([link to the book](https://www.google.com)). Please cite both the textbook and this repository if you make use of any part of this.


## Contents

* [Worked Examples](https://github.com/jstagge/hydroDrought/tree/master/worked_examples)
* [R package](https://github.com/jstagge/hydroDrought/tree/master/rpkg/hydroDrought)
* [Data](https://github.com/jstagge/hydroDrought/tree/master/data)
* [Case Studies](https://github.com/jstagge/hydroDrought/tree/master/case_studies)
* [Self-Guided Tours](https://github.com/jstagge/hydroDrought/tree/master/self_guided_tours)
* [hydroDrought R package](https://github.com/jstagge/hydroDrought/tree/master/rpkg)

## R package
In order to use the development version of the package **hydroDrought** you will need to install the package **devtools** once.

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

It provides the convenient command `install_github()` which installs the most recent version of a package hosted on github. To do so, simply execute the following three lines:

``` r
library(devtools)
install_github("jstagge/hydroDrought/rpkg/hydroDrought")
library(hydroDrought)
```

## Reference and How to Cite

For any description of this methodology, please use the following citation (s):

* The book citation [The book citation chapter](https://github.com/jstagge/reproduc_hyd/blob/master/assets/stagge_et_al_reproducibility_preprint.pdf)

* The github citation (2018)  doi: 10.5281/zenodo.1467417


## Authors

* **James H. Stagge** - *Owner* - [jstagge](https://github.com/jstagge)
* **Tobias Gauster** - *Owner* - [mundl](https://github.com/mundl)


## License
This project is licensed under the GNU General Public License v3.0 License - see the [LICENSE](LICENSE) file for details


## Acknowledgments   
This material is based upon work supported by ........... Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of any of the funding organizations.