rclm: Linear Rating-curve model
In markwh/rcmodel: Calibrate and Validate Rating Curves for Riverine Load Estimation
Description
Usage
Arguments
Details
Description
Fits linear models to log-log relationships using 'mgcv::lm',
but incorporates aspects
specific to hydrologic rating curves. Specifically, tracks the geometric mean of
flow and concentration, adjusts for transformation bias, and calculates relevant
fit statistics such as Nash-Sutcliffe efficiency (NSE)
Usage
1
Arguments
formula
a lm formula. See 'help("lm")' for details.
data
an object of class rcData, generated using 'makeModelData', or a data frame that makeModelData can use.
...
further arguments passed to 'mgcv::gam'
timeout
the amount of time in seconds to try mgcv::gam before stopping with a timeout error
Details
Dots get passed to lm() call.
All logarithms are base e (natural log)
Arguments ending in "var" are names of objects that will be assigned in the function.
logflowvar and logcvar will be shifted to have mean zero. POSSIBLY CHANGE THIS?
markwh/rcmodel documentation built on May 21, 2019, 12:26 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details
Description
Fits linear models to log-log relationships using 'mgcv::lm', but incorporates aspects specific to hydrologic rating curves. Specifically, tracks the geometric mean of flow and concentration, adjusts for transformation bias, and calculates relevant fit statistics such as Nash-Sutcliffe efficiency (NSE)
Usage
1 |
Arguments
formula |
a lm formula. See 'help("lm")' for details. |
data |
an object of class rcData, generated using 'makeModelData', or a data frame that makeModelData can use. |
... |
further arguments passed to 'mgcv::gam' |
timeout |
the amount of time in seconds to try mgcv::gam before stopping with a timeout error |
Details
Dots get passed to lm() call. All logarithms are base e (natural log) Arguments ending in "var" are names of objects that will be assigned in the function. logflowvar and logcvar will be shifted to have mean zero. POSSIBLY CHANGE THIS?
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.