yearlyPeaks: Finds datetimes of annual max values

In CentreForHydrology/CRHMr: Pre- and post- processing for CRHM

Finds datetimes of annual max values

Description

Finds the annual maxima (and, optionally, minima) of the specfied columns in a CRHM dataframe and their corresponding datetimes.

Usage

yearlyPeaks(CRHMdata, columns = 0, minvals = FALSE, logfile = "")

Arguments

CRHMdata	Required. A CRHMr dataframe.
columns	Optional. A vector containing the columns to be analyzed, not including the datetime column. If not specified, all data columns are used.
minvals	Optional. Logical. Specifies if yearly minimum values should also be found. Default value is FALSE.
logfile	Optional. Name of the file to be used for logging the action. Normally not used.

Value

Returns a dataframe with maximum (and minimum if selected) values, and their corresponding datetimes, for each year for each selected variable.

Author(s)

Kevin Shook

See Also

aggDataframe

Examples

## Not run: 
p <- yearlyPeaks(BrandonObs, columns=c(1,2), minvals=TRUE)
## End(Not run)

CentreForHydrology/CRHMr documentation built on April 6, 2024, 5:27 p.m.