Skip to contents

Extract station information from the HYDAT database

Source: R/hy_stations.R
hy_stations.Rd

Provides wrapper to turn the hy_stations table in HYDAT into a tidy data frame of station information. station_number and prov_terr_state_loc can both be supplied. If both are omitted all values from the hy_stations table are returned. This is the entry point for most analyses is tidyhydat as establish the stations for consideration is likely the first step in many instances.

Usage

hy_stations(
  station_number = NULL,
  hydat_path = NULL,
  prov_terr_state_loc = NULL
)

Format

A tibble with 15 variables:

STATION_NUMBER

Unique 7 digit Water Survey of Canada station number

STATION_NAME

Official name for station identification

PROV_TERR_STATE_LOC

The province, territory or state in which the station is located

REGIONAL_OFFICE_ID

The identifier of the regional office responsible for the station. Links to hy_reg_office_list

HYD_STATUS

Current status of discharge or level monitoring in the hydrometric network

SED_STATUS

Current status of sediment monitoring in the hydrometric network

LATITUDE

North-South Coordinates of the gauging station in decimal degrees

LONGITUDE

East-West Coordinates of the gauging station in decimal degrees

DRAINAGE_AREA_GROSS

The total surface area that drains to the gauge site (km^2)

DRAINAGE_AREA_EFFECT

The portion of the drainage basin that contributes runoff to the gauge site, calculated by subtracting any noncontributing portion from the gross drainage area (km^2)

RHBN

Logical. Reference Hydrometric Basin Network station. The Reference Hydrometric Basin Network (RHBN) is a sub-set of the national network that has been identified for use in the detection, monitoring, and assessment of climate change.

REAL_TIME

Logical. Indicates if a station has the capacity to deliver data in real-time or near real-time

CONTRIBUTOR_ID

Unique ID of an agency that contributes data to the HYDAT database. The agency is non-WSC and non WSC funded

OPERATOR_ID

Unique ID of an agency that operates a hydrometric station

DATUM_ID

Unique ID for a datum

Source

HYDAT

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.

Value

A tibble of stations and associated metadata

See also

Other HYDAT functions: hy_agency_list(), hy_annual_instant_peaks(), hy_annual_stats(), hy_daily(), hy_daily_flows(), hy_daily_levels(), 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(), hy_sed_samples_psd(), hy_stn_data_coll(), hy_stn_data_range(), hy_stn_op_schedule(), hy_stn_regulation(), hy_version()

Examples

if (FALSE) { # \dontrun{
## Multiple stations province not specified
hy_stations(station_number = c("08NM083", "08NE102"))

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