tidyhydat: hy_annual_stats – R documentation

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

hy_annual_stats

Extract annual statistics information from the HYDAT database

Description

Provides wrapper to turn the ANNUAL_STATISTICS table in HYDAT into a tidy data frame of annual statistics. Statistics provided include MEAN, MAX and MIN on an annual basis.

Usage

hy_annual_stats(
  station_number = NULL,
  hydat_path = NULL,
  prov_terr_state_loc = NULL,
  start_year = "ALL",
  end_year = "ALL"
)

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

Format

A tibble with 8 variables:

STATION_NUMBER: Unique 7 digit Water Survey of Canada station number
Parameter: Parameter being measured. Only possible values are FLOW and LEVEL
Year: Year of record.
Sum_stat: Summary statistic being used.
Value: Value of the measurement. If Parameter equals FLOW the units are m^3/s. If Parameter equals LEVEL the units are metres.
Date: Observation date. Formatted as a Date class. MEAN is a annual summary and therefore has an NA value for Date.
Symbol: Measurement/river conditions

Value

A tibble of hy_annual_stats.

Source

HYDAT

Examples

## Not run: 
  ## Multiple stations province not specified
  hy_annual_stats(station_number = c("08NM083","05AE027"))

  ## Multiple province, station number not specified
  hy_annual_stats(prov_terr_state_loc = c("AB","SK"))

## 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