hy_stn_data_coll: Extract station data collection from HYDAT database

View source: R/hy.R

hy_stn_data_collR Documentation

Extract station data collection from HYDAT database

Description

hy_stn_data_coll look-up Table

Usage

hy_stn_data_coll(
  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 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.

Format

A tibble with 6 variables:

STATION_NUMBER

Unique 7 digit Water Survey of Canada station number

DATA_TYPE

The type of data

Year_from

First year of use

Year_to

Last year of use

MEASUREMENT

The sampling method used in the collection of sediment data or the type of the gauge used in the collection of the hydrometric data

OPERATION

The schedule of station operation for the collection of sediment or hydrometric data

Value

A tibble of hy_stn_data_coll

Source

HYDAT

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_range(), hy_stn_op_schedule(), hy_stn_regulation(), hy_version()

Examples

## Not run: 
hy_stn_data_coll(station_number = c("02JE013", "08MF005"))

## End(Not run)


ropensci/tidyhydat documentation built on Jan. 26, 2024, 3:11 a.m.