View source: R/hy_annual_instant_peaks.R
hy_annual_instant_peaks | R Documentation |
Provides wrapper to turn the ANNUAL_INSTANT_PEAKS table in HYDAT into a tidy data frame of instantaneous flows and water levels.
station_number
and prov_terr_state_loc
can both be supplied.
hy_annual_instant_peaks(
station_number = NULL,
hydat_path = NULL,
prov_terr_state_loc = NULL,
start_year = NULL,
end_year = NULL
)
station_number |
A seven digit Water Survey of Canada station number. If this argument is omitted, the value of |
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 |
start_year |
First year of the returned record |
end_year |
Last year of the returned record |
A tibble of hy_annual_instant_peaks.
HYDAT
Other HYDAT functions:
hy_agency_list()
,
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_stn_regulation()
,
hy_version()
## Not run:
## Multiple stations province not specified
hy_annual_instant_peaks(station_number = c("08NM083", "08NE102"))
## Multiple province, station number not specified
hy_annual_instant_peaks(prov_terr_state_loc = c("AB", "YT"))
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.