Package: tidyhydat 1.0.0

Sam Albers

tidyhydat: Extract and Tidy Canadian 'Hydrometric' Data

Provides functions to access historical and real-time national 'hydrometric' data from Water Survey of Canada data sources and then applies tidy data principles.

Authors:Sam Albers [aut, cre, cph], Province of British Columbia [cph], Tula Foundation [cph], David Hutchinson [ctb], Dewey Dunnington [ctb], Ryan Whaley [ctb], Government of Canada [dtc], Luke Winslow [rev], Laura DeCicco [rev]

tidyhydat_1.0.0.tar.gz
tidyhydat_1.0.0.zip(r-4.6)tidyhydat_1.0.0.zip(r-4.5)tidyhydat_1.0.0.zip(r-4.4)
tidyhydat_1.0.0.tgz(r-4.6-any)tidyhydat_1.0.0.tgz(r-4.5-any)
tidyhydat_1.0.0.tar.gz(r-4.6-any)tidyhydat_1.0.0.tar.gz(r-4.5-any)
tidyhydat_1.0.0.tgz(r-4.5-emscripten)
tidyhydat.pdf |tidyhydat.html✨
tidyhydat/json (API)
NEWS

# Install 'tidyhydat' in R:
install.packages('tidyhydat', repos = c('https://ropensci.r-universe.dev', 'https://cloud.r-project.org'))

Reviews:rOpenSci Software Review #152

Bug tracker:https://github.com/ropensci/tidyhydat/issues

Pkgdown/docs site:https://docs.ropensci.org

Datasets:

On CRAN:

Conda:

citzgovernment-datahydrologyhydrometricstidy-datawater-resources

10.24 score 71 stars 3 packages 260 scripts 556 downloads 56 exports 46 dependencies

Last updated from:020d10f279 (on main). Checks:9 OK, 1 NOTE. Indexed: yes.

TargetResultTotal timeArtifact
linux-devel-x86_64OK177
pkgdown docsOK172
source / vignettesOK206
linux-release-x86_64OK182
macos-devel-arm64OK176
macos-release-arm64OK135
windows-develOK142
windows-releaseOK167
windows-oldrelNOTE155
wasm-releaseOK136

Exports:available_flowsavailable_levelsdownload_hydatenexprenquoensymexprexprshy_agency_listhy_annual_instant_peakshy_annual_statshy_dailyhy_daily_flowshy_daily_levelshy_datum_listhy_default_dbhy_dirhy_downloaded_dbhy_monthly_flowshy_monthly_levelshy_plothy_reg_office_listhy_remotehy_sed_daily_loadshy_sed_daily_susconhy_sed_monthly_loadshy_sed_monthly_susconhy_sed_sampleshy_sed_samples_psdhy_set_default_dbhy_srchy_src_disconnecthy_stationshy_stn_data_collhy_stn_data_rangehy_stn_datum_convhy_stn_datum_unrelatedhy_stn_op_schedulehy_stn_regulationhy_stn_remarkshy_test_dbhy_versionpull_station_numberquoquo_namequosrealtime_add_local_datetimerealtime_daily_meanrealtime_ddrealtime_plotrealtime_stationsrealtime_wssearch_stn_namesearch_stn_numbersymsyms

Dependencies:askpassbitbit64blobcachemclicliprcpp11crayoncurlDBIdbplyrdplyrfastmapgenericsgluehmshttr2lifecyclelubridatemagrittrmemoiseopensslpillarpkgconfigplogrprettyunitsprogresspurrrR6rappdirsreadrrlangRSQLitestringistringrsystibbletidyrtidyselecttimechangetzdbutf8vctrsvroomwithr

Stepping into the HYDAT Database

Dewey Dunnington

Rendered fromtidyhydat_hydat_db.Rmdusingknitr::rmarkdownon Feb 03 2026.

Last update: 2026-02-03
Started: 2018-01-17

tidyhydat: An Introduction

Sam Albers

Rendered fromtidyhydat_an_introduction.Rmdusingknitr::rmarkdownon Feb 03 2026.

Last update: 2026-02-03
Started: 2017-11-06

Two examples of using tidyhydat

Sam Albers

Rendered fromtidyhydat_example_analysis.Rmdusingknitr::rmarkdownon Feb 03 2026.

Last update: 2026-02-03
Started: 2017-11-06

Readme and manuals

Help Manual

Help pageTopics
All Canadian stationsallstations
Get all available flow data (final + provisional)available_flows
Get all available level data (final + provisional)available_levels
Download and set the path to HYDATdownload_hydat
hy_agency_list functionhy_agency_list
Extract annual max/min instantaneous flows and water levels from HYDAT databasehy_annual_instant_peaks
Extract annual statistics information from the HYDAT databasehy_annual_stats
Extract all daily water level and flow measurementshy_daily
Extract daily flows information from HYDAT database or web servicehy_daily_flows
Extract daily levels information from HYDAT database or web servicehy_daily_levels
DATA SYMBOLS look-up tablehy_data_symbols
DATA TYPES look-up tablehy_data_types
Extract datum list from HYDAT databasehy_datum_list
Output OS-independent path to the HYDAT sqlite databasehy_dir
Extract monthly flows information from the HYDAT databasehy_monthly_flows
Extract monthly levels information from the HYDAT databasehy_monthly_levels
This function is deprecated in favour of generic plot methodshy_plot
Extract regional office list from HYDAT databasehy_reg_office_list
Get the version date of HYDAT that is current on the ECCC websitehy_remote
Extract daily sediment load information from the HYDAT databasehy_sed_daily_loads
Extract daily suspended sediment concentration information from the HYDAT databasehy_sed_daily_suscon
Extract monthly flows information from the HYDAT databasehy_sed_monthly_loads
Extract monthly flows information from the HYDAT databasehy_sed_monthly_suscon
Extract instantaneous sediment sample information from the HYDAT databasehy_sed_samples
Extract instantaneous sediment sample particle size distribution information from the HYDAT databasehy_sed_samples_psd
Set the default database pathhy_set_default_db
Open a connection to the HYDAT databasehy_src hy_src_disconnect
Extract station information from the HYDAT databasehy_stations
Extract station data collection from HYDAT databasehy_stn_data_coll
Extract station data range from HYDAT databasehy_stn_data_range
Extract station datum conversions from HYDAT databasehy_stn_datum_conv
Extract station datum unrelated from HYDAT databasehy_stn_datum_unrelated
Extract station operation schedule from HYDAT databasehy_stn_op_schedule
Extract station regulation from the HYDAT databasehy_stn_regulation
Extract station remarks from HYDAT databasehy_stn_remarks
Get the location of the HYDAT databasehy_default_db hy_downloaded_db hy_test_db
Extract version number from HYDAT databasehy_version
Parameter IDparam_id
Plot available data (final + provisional)plot plot.available plot.hy plot.realtime
Convenience function to pull station number from tidyhydat functionspull_station_number
Add local datetime column to realtime tibblerealtime_add_local_datetime
Calculate daily means from higher resolution realtime datarealtime_daily_mean
Download a tibble of realtime river data from the last 30 days from the Meteorological Service of Canada datamartrealtime_dd
Convenience function to plot realtime datarealtime_plot
Download a tibble of active realtime stationsrealtime_stations
Download realtime data from the ECCC web servicerealtime_ws
A search function for hydrometric station name or numbersearch_stn_name search_stn_number
Summarize available data by stationsummary.available