fluvialgeomorph/fluvgeo

An R Package for Performing Fluvial Geomrphology Analysis.

FluvialGeomorph ArcGIS toolbox

The FluvialGeomorph ArcGIS toolbox provides a set of tools for extracting river channel dimensions from high resolution terrain data.

Project Status

Description

The FluvialGeomorph ArcGIS toolbox is a Python/R toolbox used to rapidly assess stream condition and health using remotely sensed terrain data (LiDAR) at fine scale and for large spatial extents. This toolbox was initially inspired by the approach and techniques of the River Bathymetry Toolkit, RBT but expanded upon their effort by adding additional analysis tools and reports. This project is open source to help ensure that these fluvial geomorphology tools remain available for the widest use, maintenance, and adaptation.

---

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).
• Regional Sediment Management Program (RSM)
• Mississippi River Geomorphology and Potamology Program (MRG&P)
• Flood Risk Management Program (FRM)
• Engineering With Nature (EWN)

---

Latest Updates

Check out the NEWS for details on the latest updates.

---

Authors

• Christopher Haring, Fluvial Geomorphologist/Research Physical Scientist, Coastal Hydraulics Laboratory, U.S. Army Corps of Engineers
• Michael Dougherty, Geographer, Rock Island District, U.S. Army Corps of Engineers
  https://orcid.org/0000-0002-1465-5927
• Thomas Darby, Geographer, Rock Island District, U.S. Army Corps of Engineers

---

Install

To install the FluvialGeomorph ArcGIS toolbox, click the latest release above, and download the .zip archive. Unzip this archive into a working folder and open the FluvialGeomorph ArcGIS toolbox in ArcMap or ArcGIS Pro. R must be installed for many of the tools in this toolbox to work. Please see the NEWS for the software compatibility matrix and release notes. See the User Manual for more details on getting started.

---

Getting Started

Use the following guides to learn how to use the FluvialGeomorph ArcGIS toolbox.

• User Manual: https://usermanual.fluvialgeomorph.org
• Tech Manual: https://techmanual.fluvialgeomorph.org

---

Bug Reports

If you find any bugs while using the FluvialGeomorph ArcGIS toolbox, please open an issue in this repository.

---

Credits

• hex logo created using the hexSticker R package
• hex logo oblique aerial photo from pexels.com

fluvgeo's Issues

Remove all `maptiles` dependencies

Choose the x-axis units for longitudinal profile graphs

The compare_long_profile and compare_xs_long_profile functions allow the user to choosethe units for the x-axis. This needs to be done for all current and future "longitudinal profile" graphs:

• xs_profile_plot
• xs_metric_plot
• xs_metrics_plot_2

Level 1 Reports not working

Here is the error message reported by @tadarby12

Add a new Level 1 report graph to display WSE, slope, and sinuosity

The Level 1 report could be improved by adding a graph of WSE, slope, and sinuosity. All of these metrics are able to be calculated at the Level 1 stage. After running the "Flowline Points" tool, a user would run the "Gradient" tool to calculate the slope and sinuosity. This plot would display WSE (smoothed?), slope, and sinuosity. It would be added to the Level 1 report after the XS longitudinal profile plot.

Add a direction of flow indicator to `map_xs`

When zoomed in tight on a cross section, one has to remember from the reach overview map, what is the direction of flow. A "direction of flow indicator" would be helpful to orient the reader.

Complete dataset documentation

All package data must have documentation.

Organize functions with topical prefixes

To help group the growing number of functions by type, functions could be organized using topical prefixes:

• map_ - Functions that produce maps.
• plot_ - Functions that produce plots (graph figures).
• metric_ - Functions that calculate metrics.
• check_ - Functions that check feature class schemas.
• report_ - Functions that produce reports.
• arc_ - Functions that import data from ESRI products using the arcgisbinding package.
• sf_ - Functions that convert to sf.
• util_ - Functions that don't warrant a unique group.

fix error in `map_xs` function

The 'map_xs' throws the following error: Error: $ operator is invalid for atomic vectors

Complete migration from `raster` to `terra`

Refactor `xs_dimension_report` into `Level 2` report and `Level 3` report

Split the existing xs_dimension_report into 2 different reports to match the new Level 1, 2, 3 project structure:

• Level 1 - Report summarizes stream channel elevation data.
• Level 2 - Report summarizes stream channel dimensions.
• Level 3 - Report summarizes stream planform dimensions.

Add graphs to Estimate Bankfull report

Add the following graphs to the Estimate Bankfull report:

• longitudinal profile graph using riffles
• level 2 metrics
• remove floodprone from the longitudinal profile graphs

Don't label every map cross section

Don't label every cross section on the map as it is unreadable when the XSs are closely spaced. Change symbol to a solid point and label every 10th XS with a label.

Don't label every cross section

XS should be labeled every 10th xs on the XS Longitudinal Profile Plot.

Install earlier version

Maptile replacement

Identify and implement a map tile/basemap replacement option to mitigate errors with ceramic

Update reports to use refactored `map_xs`

Level 1 Report cross sections are not sorted.

In the the level 1 report, the cross sections are not sorted. They appear in the record order of the input feature class.

Fix report `ggrepel` warnings

Reports L2 and L3 are issuing ggrepel warnings about too many overlapping labels causing unlabeled points. Not clear which plot is causing the warnings.

fix the CRS warning in tests

Add an overview inset map to `map_xs`

When zoomed in on a specific cross section, it would be helpful to have the context of the rest of the reach. Add an overview inset map in the lower right corner. See https://geocompr.robinlovelace.net/adv-map.html for details.

warn user of missing DEM or detrend values

The cross section points feature classes should not have missing DEM or detrend elevation values. If they do, the cross section extended further than the raster. Warn the user to fix these before proceeding.

GOF series check

The estimate_bankfull_report function calls the xs_dimensions and the build_gof_stats functions that both require the parameter bankfull_elevations. The bankfull_elevations parameter is a series that must contain the value of the bf_estimate. Build a check that warns the user if the bf_estimate is not in the bankfull_elevations series.

Estimate Bankfull report is broken

Reverse the direction of the `xs_profile_plot`

Historically longitudinal profile plots have displayed the upstream end of a reach on the left side of the graph (ggplot::x_coord_reverse). However, this goes against the typical graph layout with y-axis and x-axis origin in the lower left. More recent longitudinal Level 1 longitudinal profile graphs in fluvgeo (i.e., compare_long_profile, compare_xs_long_profile) have been built using this more common approach.

If we decide to make this change it will effect several other graphs (Regional Hydraulic Geometry Curves, and Cross Section Metric graphs). Do all of these changes need to be made at the same time?

Move testing data into its own data package

Testing data has grown far too large to be included in the package. It needs to be split into its own package.

Add aerial photos to `map_reach_overview`

The map_reach_overview function must have an aerial photo background to allow the user to identify the context of each cross section. The tmap::read_osm that was used to display aerial photos is no longer working. Find a replacement.

Can we remove the `pander` reference?

In the spirit of reducing dependencies, determine if the pander dependency is still required. It originally was used to help format report headings.

Create a packagedown site

Create a packagedown site for this project.