R/data_example.R

In frenkg/courseraeq: Clean and Plot NOAA's Earthquakes Database Information

#' Sample of 100 observations of the NOAA Earthquakes Database
#'
#' This is a sample dataset contaitning information about earquakes registered
#'   in the NOAA database, after applying the \code{eq_clean_data} function.
#'   Only relevant variables are throughly documented
#'
#' @format A data frame with 100 rows and 6 variables:
#' \describe{
#'   \item{DATE}{generated variable: date of the event}
#'   \item{LOCATION_NAME}{Location of the earthquake, cleaned}
#'   \item{EQ_PRIMARY}{earthquake magnitude}
#'   \item{DEATHS}{number of deaths caused by the earthquake}
#'   \item{LATITUDE}{latitude of the earthquake}
#'   \item{LONGITUDE}{longitude of the earthquake}
#'   ...
#' }
#' @source \url{http://nooa.com}
"data_example"

#' Full dataset of observations of the NOAA Earthquakes Database
#'
#' This is the full dataset contaitning information about earquakes registered
#'   in the NOAA database.
#'
#' @format A data frame with 5950 rows and 48 variables:
#' \describe{
#'   \item{COUNTRY}{not used}
#'   \item{DAMAGE_DESCRIPTION}{not used}
#'   \item{DAMAGE_MILLIONS_DOLLARS}{not used}
#'   \item{DAY}{day when the earthquake occurred}
#'   \item{DEATHS}{number of deaths caused by the earthquake}
#'   \item{DEATHS_DESCRIPTION}{not used}
#'   \item{EQ_MAG_MB}{not used}
#'   \item{EQ_MAG_MFA}{not used}
#'   \item{EQ_MAG_ML}{not used}
#'   \item{EQ_MAG_MS}{not used}
#'   \item{EQ_MAG_MW}{not used}
#'   \item{EQ_MAG_UNK}{not used}
#'   \item{EQ_PRIMARY}{earthquake magnitude}
#'   \item{FLAG_TSUNAMI}{not used}
#'   \item{FOCAL_DEPTH}{not used}
#'   \item{HOUR}{not used}
#'   \item{HOUSES_DAMAGED}{not used}
#'   \item{HOUSES_DAMAGED_DESCRIPTION}{not used}
#'   \item{HOUSES_DESTROYED}{not used}
#'   \item{HOUSES_DESTROYED_DESCRIPTION}{not used}
#'   \item{INJURIES}{not used}
#'   \item{INJURIES_DESCRIPTION}{not used}
#'   \item{INTENSITY}{not used}
#'   \item{I_D}{not used}
#'   \item{LATITUDE}{latitude of the earthquake}
#'   \item{LOCATION_NAME}{Location of the earthquake, cleaned}
#'   \item{LONGITUDE}{longitude of the earthquake}
#'   \item{MINUTE}{not used}
#'   \item{MISSING}{not used}
#'   \item{MISSING_DESCRIPTION}{not used}
#'   \item{MONTH}{month when the earthquake occurred}
#'   \item{REGION_CODE}{not used}
#'   \item{SECOND}{not used}
#'   \item{STATE}{not used}
#'   \item{TOTAL_DAMAGE_DESCRIPTION}{not used}
#'   \item{TOTAL_DAMAGE_MILLIONS_DOLLARS}{not used}
#'   \item{TOTAL_DEATHS}{not used}
#'   \item{TOTAL_DEATHS_DESCRIPTION}{not used}
#'   \item{TOTAL_HOUSES_DAMAGED}{not used}
#'   \item{TOTAL_HOUSES_DAMAGED_DESCRIPTION}{not used}
#'   \item{TOTAL_HOUSES_DESTROYED}{not used}
#'   \item{TOTAL_HOUSES_DESTROYED_DESCRIPTION}{not used}
#'   \item{TOTAL_INJURIES}{not used}
#'   \item{TOTAL_INJURIES_DESCRIPTION}{not used}
#'   \item{TOTAL_MISSING}{not used}
#'   \item{TOTAL_MISSING_DESCRIPTION}{not used}
#'   \item{YEAR}{year when the earthquake occurred}
#'   ...
#' }
#' @source \url{http://nooa.com}
"rawdata"