tidyhydat (version 0.3.2)

hy_stn_regulation: Extract station regulation from the HYDAT database

Description

Provides wrapper to turn the hy_stn_regulation table in HYDAT into a tidy data frame of station regulation. station_number and prov_terr_state_loc can both be supplied. If both are omitted all values from the hy_stations table are returned.

Usage

hy_stn_regulation(station_number = NULL, hydat_path = NULL,
  prov_terr_state_loc = 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 default for this argument is to look for hydat in the same location where it was saved by using download_hydat. Therefore this argument is almost always omitted from a function call. You can see where hydat was downloaded using hy_dir()

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)

Value

A tibble of stations, years of regulation and the regulation status

Format

A tibble with 4 variables:

STATION_NUMBER

Unique 7 digit Water Survey of Canada station number

YEAR_FROM

First year of use

YEAR_TO

Last year of use

REGULATED

logical

See Also

Other HYDAT functions: hy_agency_list, hy_annual_instant_peaks, 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_version

Examples

# NOT RUN {
## Multiple stations province not specified
hy_stn_regulation(station_number = c("08NM083","08NE102"))

## Multiple province, station number not specified
hy_stn_regulation(prov_terr_state_loc = c("AB","YT"))
# }
# NOT RUN {
# }