README.md

In rchlumsk/rcr: River Computations in R

rcr

rcr is an R package to calculate a basic backwater profile for open channels using the standard step method.

The package is currently configured for backwater calculations with the subcritical assumption in open channels only, supercritical and mixed regimes, and hydrualic structures, will be added in future versions.

Helpful functions in the package include:

• compute_flow_profiles computes flow profiles for a given geometry for a vector of flow values
• bankfull_estimator applies Manning's equation to estimate flow for a given cross-section, slope and water surface level
• flow_area calculates the flow area for a set of stations in a cross-section
• normal_depth calculates the normal depth of a cross-section

Installation

You can install rcr from github with:

# install.packages("devtools")
devtools::install_github("rchlumsk/rcr")

rcr Wishlist

Any issues or feature requests can be submitted on Github via the Issues tab. You may also submit feature requests directly to Robert Chlumsky ([e-mail]) via email.

Examples

See the vignettes in the package for examples of using the package functions using the sample data provided with the package.

rchlumsk/rcr documentation built on Oct. 3, 2019, 7:47 a.m.