-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
68 lines (52 loc) · 4.31 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
62
63
64
65
66
67
68
---
title: "ReadMe"
output: md_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
<!-- rmarkdown::render(input="README.Rmd", output_file = "README.md", output_format = "md_document") -->
<img src="man/figures/fluvgeo-3.png" width=250 align="right" />
# fluvgeo
An `R` Package for Performing **Fluv**ial **Geo**mrphology Analysis
## Package Status
[](https://www.tidyverse.org/lifecycle)
[](https://www.repostatus.org/#active)
[](commits/master)
[)`-yellowgreen.svg)](/commits/master)
[](http://choosealicense.com/licenses/cc0-1.0/)
## Description
This package contains a wide range of functions for performing fluvial
geomorphic analysis. This `R` package is designed for use with the [FluvialGeomorph
ArcGIS toolbox](https://github.com/FluvialGeomorph/FluvialGeomorph). The FluvialGeomorph ArcGIS toolbox contains an tools that can be used to extract spatial data from high-resolution terrain data. The FluvialGeomorph ArcGIS toolbox depends on functions in this package to perform a wide range of fluvial geomorphic analysis:
* Calculate stream channel dimensions
* Calculate stream planform dimensions
* Produce reports of stream channel and planform dimensions
* Tools for choosing a bankfull elevation for ungaged streams
<img src="man/figures/HDQLO-03_h120.jpg" width=125 align="right" />
## Funding
Funding for development and maintenance of FluvialGeomorph has been provided by the following US Army Corps of Engineers (USACE) programs:
* [Ecosystem Management and Restoration Research Program (EMRRP)](https://emrrp.el.erdc.dren.mil).
* [Regional Sediment Management Program (RSM)](https://rsm.usace.army.mil/)
* [Mississippi River Geomorphology and Potamology Program (MRG&P)](https://www.mvd.usace.army.mil/Missions/Mississippi-River-Science-Technology/MS-River-Geomorphology-Potamology/)
* [Flood Risk Management Program (FRM)](https://www.iwr.usace.army.mil/Missions/Flood-Risk-Management/Flood-Risk-Management-Program/)
* [Engineering With Nature (EWN)](https://ewn.el.erdc.dren.mil/)
<img src="man/figures/EWN_200.png" height=75 align="right" />
<img src="man/figures/SilverJackets_200.png" height=75 align="right" />
<img src="man/figures/FRMP_200.png" height=75 align="right" />
<img src="man/figures/MRG&P_300.png" height=75 align="right" />
<img src="man/figures/RSM_200.png" height=75 align="right" />
<img src="man/figures/EMRRP_logo_200.png" height=75 align="right" />
## Latest Updates
Check out the [NEWS](NEWS.md) for details on the latest updates.
## Authors
* Michael Dougherty, Geographer, U.S. Army Corps of Engineers
<div itemscope itemtype="https://schema.org/Person"><a itemprop="sameAs" content="https://orcid.org/0000-0002-1465-5927" href="https://orcid.org/0000-0002-1465-5927" target="orcid.widget" rel="me noopener noreferrer" style="vertical-align:top;"><img src="https://orcid.org/sites/default/files/images/orcid_16x16.png" style="width:1em;margin-right:.5em;" alt="ORCID iD icon">https://orcid.org/0000-0002-1465-5927</a></div>
* Christopher Haring, Fluvial Geomorphologist/Research Physical Scientist, U.S. Army Corps of Engineers
* Barrie Chileen Martinez, Geographer, U.S. Army Corps of Engineers
<div itemscope itemtype="https://schema.org/Person"><a itemprop="sameAs" content="https://orcid.org/0000-0002-6960-8167" href="https://orcid.org/0000-0002-6960-8167" target="orcid.widget" rel="me noopener noreferrer" style="vertical-align:top;"><img src="https://orcid.org/sites/default/files/images/orcid_16x16.png" style="width:1em;margin-right:.5em;" alt="ORCID iD icon">https://orcid.org/0000-0002-6960-8167</a></div>
## Install
To install the `fluvgeo` package, install from GitHub using the `devtools` package:
```{r install, eval=FALSE}
remotes::install_github(repo = "FluvialGeomorph/fluvgeo@*release")
```
## Bug Reports
If you find any bugs using `fluvgeo`, please open an [issue](https://github.com/FluvialGeomorph/fluvgeo/issues).