hydrostats (version 0.2.9)

partial.series: Partial and annual exceedence series.

Description

Returns a partial or annual exceedence series (ari=1) based on a user defined recurrence interval (ari).

For analyses based on a defined threshold (rather than recurrence interval) use high.spells instead.

Usage

partial.series(flow.ts, ari = 2, ind.days = 7, duration = T, plot = F, volume = T, 
series = 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)

ari

The desired average return interval. As a partial series, an ari of 1 will return statistics for the n largest floods in n years of record (also referred to as the annual exceedence series). The annual maximum series can be derived from high.spells with annual.stats=T

ind.days

Spells of less than ind.days (default 7) are considered to be non-independent, and only the larger of the two spells is included in the results. This behaviour differs from high.spells, where periods below the determined spell threshold of less than the independence period are infilled for the purposes of determining spell duration. This behaviour may change in the future

duration

logical. If TRUE (default), statistics describing the duration of events are returned

plot

logical. If TRUE a plot is returned showing the events included in the partial series

volume

logical. If TRUE, statistics are returned describing the volume of spells (above the spell threshold)

series

logical. If TRUE, the partial series is returned. If FALSE (default), only the indices describing the partial series are returned

Value

A list or dataframe dependening on whether series = TRUE. If TRUE, a list is returned (see below). If FALSE a dataframe is returned with all indices but without the actual partial series (p.series).

Indices

p.series

A dataframe containing an ordered partial series showing the timing and peak magnitude of events

.

n.years

Number of (almost) complete years in the series. Years with fewer than 350 non-missing values are ignored

.

n.events

Number of events in the partial series

flow.threshold

the peak volume of the smallest event include in the series

avg.duration

the average duration of events in the series

max.duration

the maximum duration of events in the series

med.spell.volume

the median volume (above the threshold) of events in the series

Examples

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

partial.series(Cooper,ari=2)
partial.series(Cooper, ari=5, plot=TRUE, ind.days=2)
partial.series(Cooper, ari=5, plot=TRUE, ind.days=10)
# }