AnnualInstantaneousPeakData: Gets the annual max/min instantantaneous data for selected...

Description Usage Arguments Value Note See Also

View source: R/Peak_Data.r

Description

Gets the annual max/min instantaneous hydrometric series (flow or level). Data are usually defined to nearest minute in local standard time (see note below).

Usage

1
AnnualInstantaneousPeakData(con, get_flow = TRUE, station_number)

Arguments

con

An open SQLite database connection to the HYDAT database

get_flow

Logical. If TRUE the function returns annual max/min instantaneous flow, otherwise the function return annual max/min instantaneous level for each station

station_number

A vector of Water Survey of Canada station identifiers

Value

A data frame (station_number, year, peak_code, precision_code, month, day, hour, minute, timezone, peak).

Note

In some cases, the timing of the instantaneous max/min may be uncertain due to equipment failure (e.g., recorder failure). Event timing may be censored by the hydrographer to reflect this uncertainty. This may lead to NA values for day or hour of occurrence. The precision_code is only valid for water level series and refers to the precision (mm or m) of the water level measurement (see ReportedWaterLevelPrecision).

See Also

AnnualPeakData for annual maximum/minimum hydrometric series. See DataSymbols for information on symbols associated with instantaneous peak values.


CentreForHydrology/HYDAT documentation built on May 27, 2019, 7:24 a.m.