tidyhydat: hy_sed_samples_psd – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

hy_sed_samples_psd

Extract instantaneous sediment sample particle size distribution information from the HYDAT database

Description

Provides wrapper to turn the hy_sed_samples_psd table in HYDAT into a tidy data frame of instantaneous sediment sample particle size distribution. station_number and prov_terr_state_loc can both be supplied. If both are omitted all values from the hy_stations table are returned. That is a large vector for hy_sed_samples_psd.

Usage

hy_sed_samples_psd(
  station_number = NULL,
  hydat_path = NULL,
  prov_terr_state_loc = NULL,
  start_date = NULL,
  end_date = NULL
)

Arguments

`station_number`	A seven digit Water Survey of Canada station number. If this argument is omitted, the value of `prov_terr_state_loc` is returned.
`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 `station_number` is returned. See `unique(allstations$prov_terr_state_loc)`. Will also accept `CA` to return only Canadian stations.
`start_date`	Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.
`end_date`	Leave blank if all dates are required. Date format needs to be in YYYY-MM-DD. Date is inclusive.

Format

A tibble with 5 variables:

STATION_NUMBER: Unique 7 digit Water Survey of Canada station number
SED_DATA_TYPE: Contains the type of sampling method used in collecting sediment for a station
Date: Contains the time to the nearest minute of when the sample was taken
PARTICLE_SIZE: Particle size (mm)
PERCENT: Contains the percentage values for indicated particle sizes for samples collected

Value

A tibble of sediment sample particle size data

Source

HYDAT

Examples

## Not run: 
hy_sed_samples_psd(station_number = "01CA004")
          
## End(Not run)

tidyhydat

Extract and Tidy Canadian 'Hydrometric' Data

v0.5.2

Apache License (== 2.0) | file LICENSE

Authors

Sam Albers [aut, cre] (<https://orcid.org/0000-0002-9270-7884>), David Hutchinson [ctb], Dewey Dunnington [ctb], Ryan Whaley [ctb], Province of British Columbia [cph], Luke Winslow [rev] (Reviewed for rOpenSci), Laura DeCicco [rev] (Reviewed for rOpenSci)

Initial release