tidyhydat: hy_daily_flows – R documentation

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

hy_daily_flows

Extract daily flows information from the HYDAT database

Description

Provides wrapper to turn the DLY_FLOWS table in HYDAT into a tidy data frame of daily flows. station_number and prov_terr_state_loc can both be supplied. If both are omitted all values from the hy_stations table are returned. That is a large tibble for hy_daily_flows.

Usage

hy_daily_flows(
  station_number = NULL,
  hydat_path = NULL,
  prov_terr_state_loc = NULL,
  start_date = NULL,
  end_date = NULL,
  symbol_output = "code"
)

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_date`	Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
`end_date`	Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
`symbol_output`	Set whether the raw code, or the `english` or the `french` translations are outputted. Default value is `code`.

Format

A tibble with 5 variables:

STATION_NUMBER: Unique 7 digit Water Survey of Canada station number
Date: Observation date. Formatted as a Date class.
Parameter: Parameter being measured. Only possible value is Flow
Value: Discharge value. The units are m^3/s.
Symbol: Measurement/river conditions

Value

A tibble of daily flows

Source

HYDAT

Examples

## Not run: 
#download_hydat()
hy_daily_flows(station_number = c("08MF005"), 
  start_date = "1996-01-01", end_date = "2000-01-01")

hy_daily_flows(prov_terr_state_loc = "PE")
          
## 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