cumulDailyWater: Cumulative water fluxes

View source: R/cumulDailyWater.R

cumulDailyWaterR Documentation

Cumulative water fluxes

Description

Accumulates water fluxes by year or water year. The values are cumulative for each day.

Usage

cumulDailyWater(dailyWaterVals, waterYear = FALSE, logfile = "")

Arguments

dailyWaterVals

Required. CRHM daily water fluxes as calculated by simpleDailyWater.

waterYear

Optional. If FALSE the fluxes are accumlated by calendar year. If TRUE the fluxes are accumulated by the water year, based on the first month of the model output.

logfile

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

Value

If successful, returns a data frame containing the date and the cumulative values of each variable. If unsuccessful, returns FALSE.

Note

The output from this function can be plotted using simpleRibbonPlot.

Author(s)

Kevin Shook

See Also

simpleDailyWater simpleRibbonPlot

Examples

## Not run: 
waterYearCumul <- cumulDailyWater(CRHM_daily, waterYear=TRUE)

## End(Not run)

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