R/outliers_ghcnd_training_set.R

In scoutiii/HTSoutliers: Hrydological and Time Series Outlier Detection Methods

#'Sample of stations for training models.
#'
#'This data set contains a random sample of stations across the continuous
#'United States. Each station samples had at least 20 observations. All stations
#'which contained an outliers as found in \code{\link{outliers_ghcnd}} had their
#'outliers included in the data set. Then a random sample of other stations was
#'taken, and a random sample of 20 non-outliers was taken from each of those
#'stations. There are 327820 non-outliers to 36132 outliers.
#'
#'This data set can be used to train various models like a random forest.
#'
#'@format A data frame with 363952 rows and 30 variables: \describe{
#'  \item{ID}{station ID} \item{DATE}{date of the observation} \item{TYPE}{from
#'  \code{\link{outliers_ghcnd}}} \item{SNWD}{Snow depth in mm}
#'  \item{WESD}{water equivalent of snow depth in 10ths mm}
#'  \item{OUTLIER_FINAL}{0 if non-outlier 1 if outlier} \item{MONTH}{the month
#'  of the DATE} \item{STATION_AVG}{as calculated from
#'  \code{\link{create_model_variables}}} \item{STATION_SD}{as calculated from
#'  \code{\link{create_model_variables}}} \item{STATION_MAX}{as calculated from
#'  \code{\link{create_model_variables}}} \item{STATION_MIN}{as calculated from
#'  \code{\link{create_model_variables}}} \item{STATION_RANGE}{as calculated
#'  from \code{\link{create_model_variables}}} \item{YEAR_AVG}{as calculated
#'  from \code{\link{create_model_variables}}} \item{YEAR_SD}{as calculated from
#'  \code{\link{create_model_variables}}} \item{YEAR_MAX}{as calculated from
#'  \code{\link{create_model_variables}}} \item{YEAR_MIN}{as calculated from
#'  \code{\link{create_model_variables}}} \item{YEAR_RANGE}{as calculated from
#'  \code{\link{create_model_variables}}} \item{MONTH_AVG}{as calculated from
#'  \code{\link{create_model_variables}}} \item{MONTH_SD}{as calculated from
#'  \code{\link{create_model_variables}}} \item{MONTH_MAX}{as calculated from
#'  \code{\link{create_model_variables}}} \item{MONTH_MIN}{as calculated from
#'  \code{\link{create_model_variables}}} \item{MONTH_RANGE}{as calculated from
#'  \code{\link{create_model_variables}}} \item{MONTH_DENSITY}{as calculated
#'  from \code{\link{create_model_variables}}} \item{WEEK_AVG}{as calculated
#'  from \code{\link{create_model_variables}}} \item{WEEK_MAX}{as calculated
#'  from \code{\link{create_model_variables}}} \item{WEEK_MIN}{as calculated
#'  from \code{\link{create_model_variables}}} \item{WEEK_RANGE}{as calculated
#'  from \code{\link{create_model_variables}}} \item{PRISM_PPT}{as calculated
#'  from \code{\link{create_model_variables}}} \item{PRISM_TMIN}{as calculated
#'  from \code{\link{create_model_variables}}} \item{PRISM_TMAX}{as calculated
#'  from \code{\link{create_model_variables}}} }
#'
#'@source \url{https://www.ncdc.noaa.gov/ghcn-daily-description}
#'
"outliers_ghcnd_training_set"