Learn R Programming

UKFE (version 0.2.2)

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)

Value

a data.frame with columns; WaterYear and AM

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

Author

Anthony Hammond

Details

The peaks are extracted based on the UK hydrological year, which starts October 1st and ends September 30th. If there are partial years (years with missing data) the maximum value may not be the true annual maximum of the year. If there are NAs for full years in the data, an -Inf will be returned for that year.

Examples

Run this code
#Extract the Thames AMAX daily mean flow and display the first six rows
ThamesAM <- AMextract(ThamesPQ[,c(1,3)])
head(ThamesAM)

Run the code above in your browser using DataLab