eccc_hydro_annual: eccc_hydro_annual

Description Usage Arguments Value Examples

View source: R/hydrometric.R

Description

Provides access to minimum and maximum values for daily means and instantaneous values

Usage

1
eccc_hydro_annual(station_number, start_date, end_date, type = "stats", query)

Arguments

station_number

Water Survey of Canada Station identifier. See eccc_hydro_stns

start_date

Minimum date for values. If blank returns period of record.

end_date

Maximum date for values. If blank returns period of record.

type

Either "stats" for statistics on daily mean values (default) or "peaks" for statistics on instantaneous values

query

(Optional) List of queryables. This allows for more complicated queries. Specifying station_number, start_date and end_date arguments will override query. See eccc_queryables("hydrometric-annual-statistics")

Value

tibble containing minimum and maximum for years between start_date and end_date

Examples

1
2
3
4
5
6
eccc_hydro_annual(
  station_number = "02HA018",
  start_date = "2019-01-01",
  end_date = "2021-01-01",
  type = "stats"
)

rywhale/ecccgeometR documentation built on Dec. 22, 2021, 8:19 p.m.