UKFE (version 0.1.1)

AMextract: Annual maximum extraction

Description

Extracts the annual maximum peaks from a data.frame which has dates in the first column and variable in the second.

Usage

AMextract(x, Plot = TRUE)

Arguments

x

a data.frame with dates (or POSIXct) in the first column and variable in the second

Plot

a logical argument with a default of TRUE. If TRUE the extracted annual maximum is plotted

Value

a data.frame with columns; WaterYear and AM

Details

The peaks are extracted based on the UK hydrological year, which starts October 1st and ends September 30th. If there are NAs for full years in the data, an -Inf will be returned for that year.

Examples

# NOT RUN {
#Extract the Thames AMAX daily mean flow and display the first six rows
ThamesAM <- AMextract(ThamesPQ[,c(1,3)])
head(ThamesAM)
# }