R/rvn_weathercan_sample.R

In rchlumsk/RavenR: Raven Hydrological Modelling Framework R Support and Analysis

#' @title weathercan sample data for RavenR package
#'
#' @description
#' A dataset downloaded using the weathercan package for the 'KAMLOOPS A' station (station id 51423),
#' between 2016-10-01 and 2019-09-30. Additional details on the weathercan package and data formats can be found at the
#' \href{https://github.com/ropensci/weathercan}{weathercan github page}.
#'
#' Note that this sample is provided to avoid loading the weathercan package while compiling and testing the package.
#'
#' Additional information on data provided by Environment Canada can be found on the Historical Data portal.
#'
#' @format rvn_weathercan_sample is a tibble with 1095 rows, and 37 columns.
#'
#' @seealso \code{\link{rvn_rvt_write_met}} for writing rvt files from meteorological data (including weathercan data).
#'
#' @source Historical Climate Data from Environment Canada (climate.weather.gc.ca) via `weathercan` package
#'
"rvn_weathercan_sample"