hy_sed_samples: Extract instantaneous sediment sample information from the HYDAT database

Description

Provides wrapper to turn the hy_sed_samples table in HYDAT into a tidy data frame of instantaneous sediment sample information. 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.

Usage

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

Value

A tibble of instantaneous sediment samples data

Format

A tibble with 19 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
SAMPLE_REMARK_CODE: Descriptive Sediment Sample Remark in English
TIME_SYMBOL: An "E" symbol means the time is an estimate only
FLOW: Contains the instantaneous discharge in cubic metres per second at the time the sample was taken
SYMBOL_EN: Indicates a condition where the daily mean has a larger than expected error
SAMPLER_TYPE: Contains the type of measurement device used to take the sample
SAMPLING_VERTICAL_LOCATION: The location on the cross-section of the river at which the single sediment samples are collected. If one of the standard locations is not used the distance in meters will be shown
SAMPLING_VERTICAL_EN: Indicates sample location relative to the regular measurement cross-section or the regular sampling site
TEMPERATURE: Contains the instantaneous water temperature in Celsius at the time the sample was taken
CONCENTRATION_EN: Contains the instantaneous concentration sampled in milligrams per litre
SV_DEPTH2: Depth 2 for split vertical depth integrating (m)

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 database connection from hy_src() 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.

Examples

Run this code

if (FALSE) {
hy_sed_samples(station_number = "01CA004")
}