Skip to contents

Combine daily Streamflow Data from HYDAT and ECCC Realtime Sources

Source: R/ngr_hyd_q_daily.R
ngr_hyd_q_daily.Rd

Retrieve and amalgamate daily streamflow data for one or more HYDAT stations, combining historical daily flows from HYDAT with available realtime daily flow data where supported. The function warns when realtime data are unavailable and checks for missing dates in the combined time series.

Usage

ngr_hyd_q_daily(
  id_station,
  date_rt_start = Sys.Date() - 581,
  date_rt_end = Sys.Date(),
  date_hydat_start = "1980-01-01",
  ...
)

Arguments

id_station

character A character vector of one or more HYDAT station IDs

date_rt_start

Date Optional. A single start date (or string coercible to date) for realtime data retrieval. Defaults to Sys.Date() - 581 (18 months).

date_rt_end

Date Optional. A single end date (or string coercible to date) for realtime data retrieval. Defaults to Sys.Date().

date_hydat_start

character Optional. A single date (or string coercible to date) giving the start date for historical HYDAT daily flows. Default is "1980-01-01".

...

Optional. Additional arguments passed to ngr_chk_dt_complete() when checking for missing dates within each STATION_NUMBER time series (e.g., dates_print = FALSE).

Value

A data frame containing daily streamflow data for the requested stations. Warnings are emitted when realtime data are unavailable for some stations or when missing dates are detected.

Details

Historical daily flows are retrieved using tidyhydat::hy_daily_flows(). Realtime daily flows are retrieved using tidyhydat::realtime_ws() for stations that support realtime reporting, as identified by tidyhydat::realtime_stations(). Realtime data are coerced to daily resolution and typed to match the HYDAT data using ngr_tidy_type().

Input dates are validated using ngr_chk_coerce_date(). Missing daily timestamps are checked per station using ngr_chk_dt_complete().

Duplicate station-date records are removed, keeping historical HYDAT values where overlaps occur. The function reports stations with missing dates using cli messages.

Examples

ngr_hyd_q_daily(id_station = c("08NH118", "08NH126"))
#> Error in hy_src(hydat_path): No Hydat.sqlite3 found at /home/runner/.local/share/tidyhydat. Run download_hydat() to download the database.