R/data.R

#' Sample dataset
#'
#' Randomly generated dataset which shows how a metric can be visualized using a
#' heatmap.
#'
#' @format A dataframe containing 54 observations at various temperatures and
#'   preciptation and 3 resultant metrics:
#'   \describe{
#'      \item{temp}{Temperature change from historical baseline, in degrees celsius}
#'      \item{precip}{Preciptation change from historical baseline, in percentages}
#'      \item{reliability}{Reliability, in percentages}
#'      \item{critical_reliability}{Critical reliability, in percentages}
#'      \item{safeyield}{Safeyield, in... units}
#'   }
#'
#' @source Randomly generated
"reliability"

#' CMIP5 data for the Mwache river basin
#'
#' Provided to show how GCM data can be overlaid on top of a heatmap.
"CMIP5"
tbadams45/wrviz documentation built on May 31, 2019, 3:58 a.m.