View source: R/hy_annual_stats.R
hy_annual_stats | R Documentation |
Provides wrapper to turn the ANNUAL_STATISTICS table in HYDAT into a tidy data frame of annual statistics. Statistics provided include MEAN, MAX and MIN on an annual basis.
hy_annual_stats(
station_number = NULL,
hydat_path = NULL,
prov_terr_state_loc = NULL,
start_year = "ALL",
end_year = "ALL"
)
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 with 8 variables:
Unique 7 digit Water Survey of Canada station number
Parameter being measured. Only possible values are FLOW and LEVEL
Year of record.
Summary statistic being used.
Value of the measurement. If Parameter equals FLOW the units are m^3/s. If Parameter equals LEVEL the units are metres.
Observation date. Formatted as a Date class. MEAN is a annual summary and therefore has an NA value for Date.
Measurement/river conditions
A tibble of hy_annual_stats.
HYDAT
Other HYDAT functions:
hy_agency_list()
,
hy_annual_instant_peaks()
,
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_stats(station_number = c("08NM083", "05AE027"))
## Multiple province, station number not specified
hy_annual_stats(prov_terr_state_loc = c("AB", "SK"))
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.