hydrostats (version 0.2.9)

seasonality: Calculate seasonality of discharge

Description

Returns statistics decribing seasonal variation in runoff.

Usage

seasonality(flow.ts, monthly.range = FALSE)

Arguments

flow.ts

Dataframe with date and discharge data in columns named "Date" and "Q" respectively. Date must be in POSIX format (see ts.format). Missing values are ignored.

monthly.range

logical. If FALSE (default), the function returns the percentage of runoff occurring during the average driest 6 month period (as defined across all years). If true, additional statistics describing cumulative average monthly flows, the range between the runoff in the wettest and driest months, and the average number of months between the wettest and driest periods of runoff.

Value

If monthly.range=FALSE (default) the function returns a dataframe with one column with the percentage of annual runoff delivered during the average driest 6 month period.

If monthly.range=TRUE, the function returns a list with the following elements:

seasonality

The percentage of annual runoff delivered during the driest 6 months

monthly.means

Average flow in each month of the year

avg.ann.month.range

Average difference between the monthly minimum and maximum

max.min.time.dif

Average number of months between the highest and lowest monthly runoff

Examples

# NOT RUN {
data(Cooper)
Cooper<-ts.format(Cooper)

seasonality(Cooper, monthly.range=TRUE)

# }