R/data.R

In lfduquey/IETD: Inter-Event Time Definition

#' Hourly rainfall time series
#'
#' @description An artificial hourly rainfall dataset to test the functions of the package.
#'
#' @source Artificial data, it does not come from any source.
#' @format A data frame with columns:
#' \describe{
#'  \item{Date}{The time and day of the rainfall pulse}
#'  \item{Rainfall.depth}{The depth of rainfall in each time step}
#' }
#' @examples
#' \dontrun{
#'  hourly_time_series
#' }
"hourly_time_series"

#' 5-min rainfall time series
#'
#' @description An artificial 5-min rainfall dataset to test the functions of the package.
#'
#' @source Artificial data, it does not come from any source.
#' @format A data frame with columns:
#' \describe{
#'  \item{Date}{The time and day of the rainfall pulse}
#'  \item{Rainfall.depth}{The depth of rainfall in each time step}
#' }
#' @examples
#' \dontrun{
#'  five_minute_time_series
#' }
"five_minute_time_series"