keystats: Generate a range of key water supply reservoir variables

Description Usage Arguments Value Examples

View source: R/keystats.R

Description

For quuickly analyzing a range of stats relating to inflows, outflows, storage dynamics and performance.

Usage

1
keystats(Q, target, capacity)

Arguments

Q

time series object representing the release time series of a reservoir.

target

numerical. The constant target water delivery.

capacity

numerical. The active capacity of the reservoir.

Value

Returns a wide range of statistics relating to the dynamics and performance of the reservoir.

Examples

1
keystats(resX$Q_Mm3, target = 50, capacity = resX$cap_Mm3)

swd-turner/reservoir documentation built on June 9, 2021, 12:27 a.m.