R/data.R

#####################################################################
#' Streamflow data
#'
#' Daily river discharge for the station 01AD002 on
#' St-John River at Fort Kent, New-Brunswick.
#' Data range from 1926 to 2014 and have a drainage area of 14700 sq km.
#'
#' @source \url{https://wateroffice.ec.gc.ca/}
#####################################################################
"flowStJohn"

#####################################################################
#' L-moments and catchment descriptors of hydrometric station in Canada
#'
#' The L-moments of the annual maximums for 563 stations
#' were extracted from Water Survery of Canada (HYDDAT).
#' Catchment descritors are available for each stations are
#' provided by Environnement and Climate Change Canada (ECCC).
#' The best at-site distributions according to the AIC criterion are included.
#'
#'  \describe{
#'    \item{STATION}{Identification number of the station in HYDAT.}
#'    \item{BASIN_AREA}{Drainage area (sq km).}
#'    \item{PPTAVG_BAS}{Mean annual precipitation for the catchment (mm).}
#'    \item{WB_AREA_PC}{Drainage area covered by waterbodies (pct).}
#'    \item{STREAM_DENS}{Stream density (km of streams per catchment sq km).}
#'    \item{ELEV_MEAN}{Mean elevation of the catchment (m).}
#'    \item{SLOPE_PCT}{Mean slope of the catchment (pct)}
#'    \item{CENTRO_X, CENTRO_Y}{Longitude and latitude of the catchment center.}
#'    \item{ELON, ELAT}{Cartesian coordinates preserving the
#'          geographical distance. Obtained using classical
#'          multidimensional scaling.}
#'    \item{L1, LCV, LSK}{Sample mean, L-coefficiant of variation and
#'          L-coefficient of skewness of the annual maximum discharge.}
#'    \item{DISTR}{Distribution selected for the annual maximum discharge based
#'          on the Akaike Information Critrion (AIC).}
#'  }
#'
#' @source \url{https://wateroffice.ec.gc.ca/}
#####################################################################
"canFlood"

#####################################################################
#' Annual maximums from the Atlantic region of Canada
#'
#' Contains the annual maximums of 45 hydrometric stations found in the
#' region '01' of Water Survery of Canada that run-off in the Atlantic ocean.
#' Additionaly to the annual maximums, the output list includes catchment
#' descriptors (longitude, latitude, frainage area, mean annual precipitation)
#' and the geographical distance between each stations.
#'
#'
#' @source \url{https://wateroffice.ec.gc.ca/}
#####################################################################
"flowAtlantic"
martindurocher/floodStat documentation built on May 31, 2019, 12:42 a.m.