-
Notifications
You must be signed in to change notification settings - Fork 24
/
README.Rmd
61 lines (37 loc) · 2.95 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# `EflowStats`
Calculates a suite of ecological flow statistics and fundamental properties of daily streamflow for a given set of data.
### Installation
To install the latest release of EflowStats see [releases](https://github.com/doi-usgs/EflowStats/releases) to find the latest version and use:
```{r, eval = FALSE}
remotes::install_github("doi-usgs/[email protected]")
```
### [Documentation](docs/Reference_Manual_EflowStats.md)
### Code of Conduct
We want to encourage a warm, welcoming, and safe environment for contributing to this project. See the [code of conduct](https://github.com/DOI-USGS/EflowStats/blob/master/CONDUCT.md) for more information.
### Reporting bugs
Please consider reporting bugs and asking questions on the [Issues page.](https://github.com/DOI-USGS/EflowStats/issues)
### Package Support
The Water Mission Area of the USGS has supported the development and maintenance of the `EflowStats` R-package. Further maintenance is expected to be stable until further notice. Resources are available primarily for maintenance and responding to user questions. Priorities on the development of new features are determined by the `EflowStats` development team.
### Overview
The `EflowStats` package was created to simplify the process of generating hydrologic indicator statistics using daily streamflow records. It has been specifically designed to work seamlessly with U.S. Geological Survey (USGS) National Water Information System (NWIS) data. This package is intended to be an update of the previously existing USGS National Hydrologic Assessment Tool (NAHAT) program with additional statistics previously published by Archfield et al (Archfield).
### References
Henriksen, J.A., Heasley, J. Kennen, J.G., and Nieswand, S., 2006, Users' manual for the Hydroecological Integrity Assessment Process software (including the New Jersey Assessment Tools): U.S. Geological Survey Open-File Report 2006-1093. 72 p. ([https://pubs.usgs.gov/of/2006/1093/report.pdf](https://pubs.usgs.gov/of/2006/1093/report.pdf))
Archfield, S.A., J.G. Kennen, D.M. Carlisle, and D.M. Wolock. 2013. An Objective and Parsimonious Approach for Classifying Natural Flow Regimes at a Continental Scale. River Res. Applic. doi: 10.1002/rra.2710 ([http://onlinelibrary.wiley.com/doi/10.1002/rra.2710/abstract](http://onlinelibrary.wiley.com/doi/10.1002/rra.2710/abstract))
```{r disclaimer, child="DISCLAIMER.md", eval=TRUE}
```
[
](https://creativecommons.org/publicdomain/zero/1.0/)