weighingGaugeInterval: Deaccumulates weighing gauge precipitation

View source: R/weighingGaugeInterval.R

weighingGaugeIntervalR Documentation

Deaccumulates weighing gauge precipitation

Description

Converts weighing gauged cumulative precipitation to interval values. The interval precipitation is checked to make sure that it does not contain any negative values. Negative precipitation will result in the function displaying an error message and returning the value FALSE.

Usage

weighingGaugeInterval(obs, precipCol = 1, quiet = TRUE, logfile = "")

Arguments

obs

Required. A standard CRHMr obs file.

precipCol

Optional. The number of the column containing the weighting gauge cumulative precipitation data, not including the datetime. Default is column 1.

quiet

Optional. Suppresses display of messages, except for errors. If you are calling this function in an R script, you will usually leave quiet=TRUE (i.e. the default). If you are working interactively, you will probably want to set quiet=FALSE.

logfile

Optional. Name of the file to be used for logging the action. Normally not used.

Value

If unsuccessful, returns FALSE. If sucessful, returns a modified version of the obs dataframe containing the datetime, the cumulative and interval precipitation.

Author(s)

Kevin Shook

See Also

weighingGauge1 weighingGauge2 weighingGauge3 weighingGauge4 weighingGauge5 weighingGaugePlot

Examples

## Not run: 
test5 <- weightingGaugeStep5(wg)
## End(Not run)


CentreForHydrology/CRHMr documentation built on April 6, 2024, 5:27 p.m.