tidyhydat: hy_annual_instant_peaks – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

hy_annual_instant_peaks

Extract annual max/min instantaneous flows and water levels from HYDAT database

Description

Provides wrapper to turn the ANNUAL_INSTANT_PEAKS table in HYDAT into a tidy data frame of instantaneous flows and water levels. station_number and prov_terr_state_loc can both be supplied.

Usage

hy_annual_instant_peaks(
  station_number = NULL,
  hydat_path = NULL,
  prov_terr_state_loc = NULL,
  start_year = NULL,
  end_year = NULL
)

Arguments

`station_number`	A seven digit Water Survey of Canada station number. If this argument is omitted, the value of `prov_terr_state_loc` is returned.
`hydat_path`	The path to the hydat database or NULL to use the default location used by download_hydat. It is also possible to pass in an existing src_sqlite such that the database only needs to be opened once per user-level call.
`prov_terr_state_loc`	Province, state or territory. If this argument is omitted, the value of `station_number` is returned. See `unique(allstations$prov_terr_state_loc)`. Will also accept `CA` to return only Canadian stations.
`start_year`	First year of the returned record
`end_year`	Last year of the returned record

Value

A tibble of hy_annual_instant_peaks.

Source

HYDAT

Other HYDAT functions: hy_agency_list(), hy_annual_stats(), hy_daily_flows(), hy_daily_levels(), hy_daily(), hy_data_symbols, hy_data_types, hy_datum_list(), hy_monthly_flows(), hy_monthly_levels(), hy_reg_office_list(), hy_sed_daily_loads(), hy_sed_daily_suscon(), hy_sed_monthly_loads(), hy_sed_monthly_suscon(), hy_sed_samples_psd(), hy_sed_samples(), hy_stations(), hy_stn_data_coll(), hy_stn_data_range(), hy_stn_op_schedule(), hy_stn_regulation(), hy_version()

Examples

## Not run: 
## Multiple stations province not specified
hy_annual_instant_peaks(station_number = c("08NM083","08NE102"))

## Multiple province, station number not specified
hy_annual_instant_peaks(prov_terr_state_loc = c("AB","YT"))

## End(Not run)

tidyhydat

Extract and Tidy Canadian 'Hydrometric' Data

v0.5.2

Apache License (== 2.0) | file LICENSE

Authors

Sam Albers [aut, cre] (<https://orcid.org/0000-0002-9270-7884>), David Hutchinson [ctb], Dewey Dunnington [ctb], Ryan Whaley [ctb], Province of British Columbia [cph], Luke Winslow [rev] (Reviewed for rOpenSci), Laura DeCicco [rev] (Reviewed for rOpenSci)

Initial release