-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
56 lines (43 loc) · 3.47 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
# razviz {#razviz}
An R package to produce visualizations for evaluating the performance of [HEC-RAS](https://www.hec.usace.army.mil/software/hec-ras) models. <img src="man/figures/HDQLO-03_h120.jpg" align="right" />
## 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 set of standard graphing and summary table functions to help streamline the review and evaluation of HEC-RAS model results during calibration. The package currently contains functions for producing reports containing the following visualizations:
* **Hydrographs** - Compare modeled versus observed values for both water surface elevation and discharge by cross section and model scenario.
[](https://mpdougherty.github.io/razviz/doc/Hydrograph_Plot_Report.pdf)
* **Longitudinal Profile Graph** - Compare water surface elevation by river mile for multiple model scenarios. Graphs can also contain additional annotations (i.e., river gage locations, levee elevations, bridge elevations, river features, and high water marks) helpful for evaluating model results.
[](https://mpdougherty.github.io/razviz/doc/Longitudinal_Profile_Report.pdf)
* **Goodness of Fit Statistics Tables** - A table of goodness of fit statistics (i.e., R^2, RMSE, MAE) between modeled versus observed values by cross section and model scenario.
## Funding
Funding for the development and maintenance of `razviz` was provided by the US Army
Corps of Engineers (USACE):
* [Flood Plain Management Services (FPMS) Program](https://www.mvr.usace.army.mil/Business-With-Us/Outreach-Customer-Service/Floodplain-Management-Services/).
## Latest Updates
Check out the [NEWS](NEWS.md) for details on the latest updates.
## Authors
* Michael Dougherty, Geographer, U.S. Army Corps of Engineers, Rock Island District
* Leigh Allison, Hydraulic Engineer, U.S. Army Corps of Engineers, St. Paul District
* David Tsai, Hydraulic Engineer, U.S. Army Corps of Engineers, Rock Island District
* Daniel Smith, Hydraulic Engineer, U.S. Army Corps of Engineers, Rock Island District
## Install
To install the `razviz` package, install from GitHub using the `devtools` package:
```r
library(devtools)
devtools::install_github(repo = "mpdougherty/razviz@*release",
build_vignettes = TRUE)
```
## Vignettes
Learn how to use the `razviz` package to visualize your HEC-RAS model results:
* [Compare Modeled versus Observed Hydrographs](https://mpdougherty.github.io/razviz/doc/hydrographs.html)
* [Create a Longitudinal Profile Graph](https://mpdougherty.github.io/razviz/doc/longitudinal_profile.html)
## Bug Reports
If you find any bugs while using `razviz`, please open an issue in this repository.