R/dataEarthquakes.R
In Juanin2691/toolsEarthquakes: Tools for cleaning and ploting data from The Significant Earthquake Database
#' @title Significant Earthquake Dataset
#' @description Contains information on destructive earthquakes from
#' 2150 B.C. to the present that meet at least one of the following
#' criteria: Moderate damage (approximately $1 million or more), 10 or
#' more deaths, Magnitude 7.5 or greater, Modified Mercalli Intensity X or
#' greater, or the earthquake generated a tsunami.
#' @format A data frame with 6065 rows and 47 variables:
#' \describe{
#' \item{\code{I_D}}{integer The unique numeric identifier of the record.}
#' \item{\code{FLAG_TSUNAMI}}{character When a tsunami was generated by
#' an earthquake, "Tsu" appears in the Assoc Tsu column. There should also
#' be a "TSU" link in the Assoc column which is linked to the tsunami
#' event database. The TSU link will display additional tsunami event
#' information in a new browser window.}
#' \item{\code{YEAR}}{integer Format +/-yyyy (-is B.C, +is A.D.)
#' The Date and Time are given in Universal Coordinated Time (also known
#' as Greenwich Mean Time). The local date may be one day different.}
#' \item{\code{MONTH}}{integer Valid values: 1-12}
#' \item{\code{DAY}}{integer Valid values: 1-31 (where months apply)}
#' \item{\code{HOUR}}{integer Valid values: 0-23}
#' \item{\code{MINUTE}}{integer Valid values: 0-59}
#' \item{\code{SECOND}}{character Valid values: 0-59}
#' \item{\code{FOCAL_DEPTH}}{integer Valid values: 0 to 700 km
#' The depth of the earthquake is given in kilometers.}
#' \item{\code{EQ_PRIMARY}}{double Valid values: 0.0 to 9.9
#' The value in this column contains the primary earthquake magnitude.
#' Magnitude measures the energy released at the source of the earthquake.}
#' \item{\code{EQ_MAG_MW}}{double Valid values: 0.0 to 9.9
#' The Mw magnitude is based on the moment magnitude scale. Moment is a
#' physical quantity proportional to the slip on the fault times the area
#' of the fault surface that slips; it is related to the total energy
#' released in the EQ.}
#' \item{\code{EQ_MAG_MS}}{double Valid values: 0.0 to 9.9
#' The Ms magnitude is the surface-wave magnitude of the earthquake.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_MB}}{character Valid values: 0.0 to 9.9
#' The Mb magnitude is the compressional body wave (P-wave) magnitude.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_ML}}{double Valid values: 0.0 to 9.9
#' The ML magnitude was the original magnitude relationship defined by
#' Richter and Gutenberg for local earthquakes in 1935.}
#' \item{\code{EQ_MAG_MFA}}{character Valid values: 0.0 to 9.9
#' The Mfa magnitudes are computed from the felt area, for earthquakes
#' that occurred before seismic instruments were in general use.}
#' \item{\code{EQ_MAG_UNK}}{double Valid values: 0.0 to 9.9
#' The computational method for the earthquake magnitude was unknown and
#' could not be determined from the published sources.}
#' \item{\code{INTENSITY}}{integer Valid values: 1 to 12
#' The Modified Mercalli Intensity (Int) is given in Roman Numerals
#' (converted to numbers in the digital database).}
#' \item{\code{COUNTRY}}{character The Country where the Earthquake
#' occurred}
#' \item{\code{STATE}}{character The two-letter State or
#' Province abbreviation where the Earthquake occurred.}
#' \item{\code{LOCATION_NAME}}{character The Country, State, Province or City
#' where the Earthquake occurred. This is only an approximate geographic
#' location. Events prior to 1900 were not instrumentally located,
#' therefore, the location given is based on the latitude and longitude of
#' the city where the damage occurred.}
#' \item{\code{LATITUDE}}{double Valid values: -90 to +90
#' Latitude: 0 to 90 (Northern Hemisphere) -90 to 0 (Southern Hemisphere)}
#' \item{\code{LONGITUDE}}{double Valid values: -180 to +180
#' Longitude: 0 to 180 (Eastern Hemisphere) -180 to 0 (Western Hemisphere)}
#' \item{\code{REGION_CODE}}{integer Regional boundaries defined as follows:
#' 10 = Central, Western and S. Africa
#' 15 = Northern Africa
#' 20 = Antarctica
#' 30 = East Asia
#' 40 = Central Asia and Caucasus
#' 50 = Kamchatka and Kuril Islands
#' 60 = S. and SE. Asia and Indian Ocean
#' 70 = Atlantic Ocean
#' 80 = Bering Sea
#' 90 = Caribbean
#' 100 = Central America
#' 110 = Eastern Europe
#' 120 = Northern and Western Europe
#' 130 = Southern Europe
#' 140 = Middle East
#' 150 = North America and Hawaii
#' 160 = South America
#' 170 = Central and South Pacific}
#' \item{\code{DEATHS}}{integer Valid values: 0 to 1100000}
#' \item{\code{DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{MISSING}}{character Valid values: 0 to 1100000}
#' \item{\code{MISSING_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{INJURIES}}{integer Valid values: 0 to 30000}
#' \item{\code{INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{DAMAGE_MILLIONS_DOLLARS}}{character Damage in Millions of
#' Dollars from the Earthquake: The value in the Damage column should be
#' multipled by 1,000,000 to obtain the actual dollar amount.}
#' \item{\code{DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses destroyed,
#' the following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage and was
#' listed.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_DEATHS}}{integer Valid values: 0 to 1100000
#' Total number of deaths from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths, this value was coded and listed.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{TOTAL_MISSING}}{character Valid values: 0 to 1100000
#' Whenever possible, total number of missing from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_MISSING_DESCRIPTION}}{character Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{TOTAL_INJURIES}}{integer Valid values: 0 to 30000
#' Whenever possible, total number of injuries from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{TOTAL_DAMAGE_MILLIONS_DOLLARS}}{character The value in the
#' Damage column should be multipled by 1,000,000 to obtain the actual
#' dollar amount. When a dollar amount for damage was found in the
#' literature, it was listed in the Damage column in millions of U.S.
#' dollars.}
#' \item{\code{TOTAL_DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{TOTAL_HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses destroyed, the
#' following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#'}
#' @source \url{https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1}
"Earthquakes"
#' @title Example 1. Cleaned dataset
#' @description Example dataset of eq_clean_data(data = Earthquakes)
#' @format A data frame with 5508 rows and 11 variables:
#' \describe{
#' \item{\code{I_D}}{integer The unique numeric identifier of the record.}
#' \item{\code{FLAG_TSUNAMI}}{character When a tsunami was generated by
#' an earthquake, "Tsu" appears in the Assoc Tsu column. There should also
#' be a "TSU" link in the Assoc column which is linked to the tsunami
#' event database. The TSU link will display additional tsunami event
#' information in a new browser window.}
#' \item{\code{FOCAL_DEPTH}}{integer Valid values: 0 to 700 km
#' The depth of the earthquake is given in kilometers.}
#' \item{\code{EQ_PRIMARY}}{double Valid values: 0.0 to 9.9
#' The value in this column contains the primary earthquake magnitude.
#' Magnitude measures the energy released at the source of the earthquake.}
#' \item{\code{EQ_MAG_MW}}{double Valid values: 0.0 to 9.9
#' The Mw magnitude is based on the moment magnitude scale. Moment is a
#' physical quantity proportional to the slip on the fault times the area
#' of the fault surface that slips; it is related to the total energy
#' released in the EQ.}
#' \item{\code{EQ_MAG_MS}}{double Valid values: 0.0 to 9.9
#' The Ms magnitude is the surface-wave magnitude of the earthquake.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_MB}}{character Valid values: 0.0 to 9.9
#' The Mb magnitude is the compressional body wave (P-wave) magnitude.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_ML}}{double Valid values: 0.0 to 9.9
#' The ML magnitude was the original magnitude relationship defined by
#' Richter and Gutenberg for local earthquakes in 1935.}
#' \item{\code{EQ_MAG_MFA}}{character Valid values: 0.0 to 9.9
#' The Mfa magnitudes are computed from the felt area, for earthquakes
#' that occurred before seismic instruments were in general use.}
#' \item{\code{EQ_MAG_UNK}}{double Valid values: 0.0 to 9.9
#' The computational method for the earthquake magnitude was unknown and
#' could not be determined from the published sources.}
#' \item{\code{INTENSITY}}{integer Valid values: 1 to 12
#' The Modified Mercalli Intensity (Int) is given in Roman Numerals
#' (converted to numbers in the digital database).}
#' \item{\code{COUNTRY}}{character The Country where the Earthquake
#' occurred}
#' \item{\code{STATE}}{character The two-letter State or
#' Province abbreviation where the Earthquake occurred.}
#' \item{\code{LOCATION_NAME}}{character The Country, State, Province or City
#' where the Earthquake occurred. This is only an approximate geographic
#' location. Events prior to 1900 were not instrumentally located,
#' therefore, the location given is based on the latitude and longitude of
#' the city where the damage occurred.}
#' \item{\code{LATITUDE}}{double Valid values: -90 to +90
#' Latitude: 0 to 90 (Northern Hemisphere) -90 to 0 (Southern Hemisphere)}
#' \item{\code{LONGITUDE}}{double Valid values: -180 to +180
#' Longitude: 0 to 180 (Eastern Hemisphere) -180 to 0 (Western Hemisphere)}
#' \item{\code{REGION_CODE}}{integer Regional boundaries defined as follows:
#' 10 = Central, Western and S. Africa
#' 15 = Northern Africa
#' 20 = Antarctica
#' 30 = East Asia
#' 40 = Central Asia and Caucasus
#' 50 = Kamchatka and Kuril Islands
#' 60 = S. and SE. Asia and Indian Ocean
#' 70 = Atlantic Ocean
#' 80 = Bering Sea
#' 90 = Caribbean
#' 100 = Central America
#' 110 = Eastern Europe
#' 120 = Northern and Western Europe
#' 130 = Southern Europe
#' 140 = Middle East
#' 150 = North America and Hawaii
#' 160 = South America
#' 170 = Central and South Pacific}
#' \item{\code{DEATHS}}{integer Valid values: 0 to 1100000}
#' \item{\code{DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{MISSING}}{character Valid values: 0 to 1100000}
#' \item{\code{MISSING_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{INJURIES}}{integer Valid values: 0 to 30000}
#' \item{\code{INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{DAMAGE_MILLIONS_DOLLARS}}{character Damage in Millions of
#' Dollars from the Earthquake: The value in the Damage column should be
#' multipled by 1,000,000 to obtain the actual dollar amount.}
#' \item{\code{DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses destroyed,
#' the following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage and was
#' listed.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_DEATHS}}{integer Valid values: 0 to 1100000
#' Total number of deaths from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths, this value was coded and listed.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{TOTAL_MISSING}}{character Valid values: 0 to 1100000
#' Whenever possible, total number of missing from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_MISSING_DESCRIPTION}}{character Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{TOTAL_INJURIES}}{integer Valid values: 0 to 30000
#' Whenever possible, total number of injuries from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{TOTAL_DAMAGE_MILLIONS_DOLLARS}}{character The value in the
#' Damage column should be multipled by 1,000,000 to obtain the actual
#' dollar amount. When a dollar amount for damage was found in the
#' literature, it was listed in the Damage column in millions of U.S.
#' dollars.}
#' \item{\code{TOTAL_DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{TOTAL_HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses destroyed, the
#' following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{DATE}}{Date Format year/month/day, year can be negative
#' (-is B.C), or positive (+is A.D.).}
#'}
#' @source \url{https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1}
"cleanES_1"
#' @title Example 2. Cleaned dataset
#' @description Example dataset of eq_clean_data(data = Earthquakes,
#' r.na = FALSE)
#' @format A data frame with 6065 rows and 11 variables:
#' \describe{
#' \item{\code{I_D}}{integer The unique numeric identifier of the record.}
#' \item{\code{FLAG_TSUNAMI}}{character When a tsunami was generated by
#' an earthquake, "Tsu" appears in the Assoc Tsu column. There should also
#' be a "TSU" link in the Assoc column which is linked to the tsunami
#' event database. The TSU link will display additional tsunami event
#' information in a new browser window.}
#' \item{\code{FOCAL_DEPTH}}{integer Valid values: 0 to 700 km
#' The depth of the earthquake is given in kilometers.}
#' \item{\code{EQ_PRIMARY}}{double Valid values: 0.0 to 9.9
#' The value in this column contains the primary earthquake magnitude.
#' Magnitude measures the energy released at the source of the earthquake.}
#' \item{\code{EQ_MAG_MW}}{double Valid values: 0.0 to 9.9
#' The Mw magnitude is based on the moment magnitude scale. Moment is a
#' physical quantity proportional to the slip on the fault times the area
#' of the fault surface that slips; it is related to the total energy
#' released in the EQ.}
#' \item{\code{EQ_MAG_MS}}{double Valid values: 0.0 to 9.9
#' The Ms magnitude is the surface-wave magnitude of the earthquake.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_MB}}{character Valid values: 0.0 to 9.9
#' The Mb magnitude is the compressional body wave (P-wave) magnitude.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_ML}}{double Valid values: 0.0 to 9.9
#' The ML magnitude was the original magnitude relationship defined by
#' Richter and Gutenberg for local earthquakes in 1935.}
#' \item{\code{EQ_MAG_MFA}}{character Valid values: 0.0 to 9.9
#' The Mfa magnitudes are computed from the felt area, for earthquakes
#' that occurred before seismic instruments were in general use.}
#' \item{\code{EQ_MAG_UNK}}{double Valid values: 0.0 to 9.9
#' The computational method for the earthquake magnitude was unknown and
#' could not be determined from the published sources.}
#' \item{\code{INTENSITY}}{integer Valid values: 1 to 12
#' The Modified Mercalli Intensity (Int) is given in Roman Numerals
#' (converted to numbers in the digital database).}
#' \item{\code{COUNTRY}}{character The Country where the Earthquake
#' occurred}
#' \item{\code{STATE}}{character The two-letter State or
#' Province abbreviation where the Earthquake occurred.}
#' \item{\code{LOCATION_NAME}}{character The Country, State, Province or City
#' where the Earthquake occurred. This is only an approximate geographic
#' location. Events prior to 1900 were not instrumentally located,
#' therefore, the location given is based on the latitude and longitude of
#' the city where the damage occurred.}
#' \item{\code{LATITUDE}}{double Valid values: -90 to +90
#' Latitude: 0 to 90 (Northern Hemisphere) -90 to 0 (Southern Hemisphere)}
#' \item{\code{LONGITUDE}}{double Valid values: -180 to +180
#' Longitude: 0 to 180 (Eastern Hemisphere) -180 to 0 (Western Hemisphere)}
#' \item{\code{REGION_CODE}}{integer Regional boundaries defined as follows:
#' 10 = Central, Western and S. Africa
#' 15 = Northern Africa
#' 20 = Antarctica
#' 30 = East Asia
#' 40 = Central Asia and Caucasus
#' 50 = Kamchatka and Kuril Islands
#' 60 = S. and SE. Asia and Indian Ocean
#' 70 = Atlantic Ocean
#' 80 = Bering Sea
#' 90 = Caribbean
#' 100 = Central America
#' 110 = Eastern Europe
#' 120 = Northern and Western Europe
#' 130 = Southern Europe
#' 140 = Middle East
#' 150 = North America and Hawaii
#' 160 = South America
#' 170 = Central and South Pacific}
#' \item{\code{DEATHS}}{integer Valid values: 0 to 1100000}
#' \item{\code{DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{MISSING}}{character Valid values: 0 to 1100000}
#' \item{\code{MISSING_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{INJURIES}}{integer Valid values: 0 to 30000}
#' \item{\code{INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{DAMAGE_MILLIONS_DOLLARS}}{character Damage in Millions of
#' Dollars from the Earthquake: The value in the Damage column should be
#' multipled by 1,000,000 to obtain the actual dollar amount.}
#' \item{\code{DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses destroyed,
#' the following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage and was
#' listed.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_DEATHS}}{integer Valid values: 0 to 1100000
#' Total number of deaths from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths, this value was coded and listed.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{TOTAL_MISSING}}{character Valid values: 0 to 1100000
#' Whenever possible, total number of missing from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_MISSING_DESCRIPTION}}{character Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{TOTAL_INJURIES}}{integer Valid values: 0 to 30000
#' Whenever possible, total number of injuries from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{TOTAL_DAMAGE_MILLIONS_DOLLARS}}{character The value in the
#' Damage column should be multipled by 1,000,000 to obtain the actual
#' dollar amount. When a dollar amount for damage was found in the
#' literature, it was listed in the Damage column in millions of U.S.
#' dollars.}
#' \item{\code{TOTAL_DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{TOTAL_HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses destroyed, the
#' following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{DATE}}{Date Format year/month/day, year can be negative
#' (-is B.C), or positive (+is A.D.).}
#'}
#' @source \url{https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1}
"cleanES_2"
#' @title Example 3. Cleaned dataset
#' @description Example dataset of eq_location_data(data = Earthquakes)
#' @format A data frame with 6065 rows and 47 variables:
#' \describe{
#' \item{\code{I_D}}{integer The unique numeric identifier of the record.}
#' \item{\code{FLAG_TSUNAMI}}{character When a tsunami was generated by
#' an earthquake, "Tsu" appears in the Assoc Tsu column. There should also
#' be a "TSU" link in the Assoc column which is linked to the tsunami
#' event database. The TSU link will display additional tsunami event
#' information in a new browser window.}
#' \item{\code{YEAR}}{integer Format +/-yyyy (-is B.C, +is A.D.)
#' The Date and Time are given in Universal Coordinated Time (also known
#' as Greenwich Mean Time). The local date may be one day different.}
#' \item{\code{MONTH}}{integer Valid values: 1-12}
#' \item{\code{DAY}}{integer Valid values: 1-31 (where months apply)}
#' \item{\code{HOUR}}{integer Valid values: 0-23}
#' \item{\code{MINUTE}}{integer Valid values: 0-59}
#' \item{\code{SECOND}}{character Valid values: 0-59}
#' \item{\code{FOCAL_DEPTH}}{integer Valid values: 0 to 700 km
#' The depth of the earthquake is given in kilometers.}
#' \item{\code{EQ_PRIMARY}}{double Valid values: 0.0 to 9.9
#' The value in this column contains the primary earthquake magnitude.
#' Magnitude measures the energy released at the source of the earthquake.}
#' \item{\code{EQ_MAG_MW}}{double Valid values: 0.0 to 9.9
#' The Mw magnitude is based on the moment magnitude scale. Moment is a
#' physical quantity proportional to the slip on the fault times the area
#' of the fault surface that slips; it is related to the total energy
#' released in the EQ.}
#' \item{\code{EQ_MAG_MS}}{double Valid values: 0.0 to 9.9
#' The Ms magnitude is the surface-wave magnitude of the earthquake.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_MB}}{character Valid values: 0.0 to 9.9
#' The Mb magnitude is the compressional body wave (P-wave) magnitude.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_ML}}{double Valid values: 0.0 to 9.9
#' The ML magnitude was the original magnitude relationship defined by
#' Richter and Gutenberg for local earthquakes in 1935.}
#' \item{\code{EQ_MAG_MFA}}{character Valid values: 0.0 to 9.9
#' The Mfa magnitudes are computed from the felt area, for earthquakes
#' that occurred before seismic instruments were in general use.}
#' \item{\code{EQ_MAG_UNK}}{double Valid values: 0.0 to 9.9
#' The computational method for the earthquake magnitude was unknown and
#' could not be determined from the published sources.}
#' \item{\code{INTENSITY}}{integer Valid values: 1 to 12
#' The Modified Mercalli Intensity (Int) is given in Roman Numerals
#' (converted to numbers in the digital database).}
#' \item{\code{COUNTRY}}{character The Country where the Earthquake
#' occurred}
#' \item{\code{STATE}}{character The two-letter State or
#' Province abbreviation where the Earthquake occurred.}
#' \item{\code{LOCATION_NAME}}{character The State, Province or City
#' where the Earthquake occurred. This is only an approximate geographic
#' location. Events prior to 1900 were not instrumentally located,
#' therefore, the location given is based on the latitude and longitude of
#' the city where the damage occurred.}
#' \item{\code{LATITUDE}}{double Valid values: -90 to +90
#' Latitude: 0 to 90 (Northern Hemisphere) -90 to 0 (Southern Hemisphere)}
#' \item{\code{LONGITUDE}}{double Valid values: -180 to +180
#' Longitude: 0 to 180 (Eastern Hemisphere) -180 to 0 (Western Hemisphere)}
#' \item{\code{REGION_CODE}}{integer Regional boundaries defined as follows:
#' 10 = Central, Western and S. Africa
#' 15 = Northern Africa
#' 20 = Antarctica
#' 30 = East Asia
#' 40 = Central Asia and Caucasus
#' 50 = Kamchatka and Kuril Islands
#' 60 = S. and SE. Asia and Indian Ocean
#' 70 = Atlantic Ocean
#' 80 = Bering Sea
#' 90 = Caribbean
#' 100 = Central America
#' 110 = Eastern Europe
#' 120 = Northern and Western Europe
#' 130 = Southern Europe
#' 140 = Middle East
#' 150 = North America and Hawaii
#' 160 = South America
#' 170 = Central and South Pacific}
#' \item{\code{DEATHS}}{integer Valid values: 0 to 1100000}
#' \item{\code{DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{MISSING}}{character Valid values: 0 to 1100000}
#' \item{\code{MISSING_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{INJURIES}}{integer Valid values: 0 to 30000}
#' \item{\code{INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{DAMAGE_MILLIONS_DOLLARS}}{character Damage in Millions of
#' Dollars from the Earthquake: The value in the Damage column should be
#' multipled by 1,000,000 to obtain the actual dollar amount.}
#' \item{\code{DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses destroyed,
#' the following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage and was
#' listed.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_DEATHS}}{integer Valid values: 0 to 1100000
#' Total number of deaths from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths, this value was coded and listed.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{TOTAL_MISSING}}{character Valid values: 0 to 1100000
#' Whenever possible, total number of missing from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_MISSING_DESCRIPTION}}{character Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{TOTAL_INJURIES}}{integer Valid values: 0 to 30000
#' Whenever possible, total number of injuries from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{TOTAL_DAMAGE_MILLIONS_DOLLARS}}{character The value in the
#' Damage column should be multipled by 1,000,000 to obtain the actual
#' dollar amount. When a dollar amount for damage was found in the
#' literature, it was listed in the Damage column in millions of U.S.
#' dollars.}
#' \item{\code{TOTAL_DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{TOTAL_HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses destroyed, the
#' following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#'}
#' @source \url{https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1}
"cleanES_3"
#' @title DATASET_TITLE
#' @description DATASET_DESCRIPTION
#' @format a character vector with 196 elements
"country_names"
Juanin2691/toolsEarthquakes documentation built on May 28, 2019, 5:41 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
#' @title Significant Earthquake Dataset
#' @description Contains information on destructive earthquakes from
#' 2150 B.C. to the present that meet at least one of the following
#' criteria: Moderate damage (approximately $1 million or more), 10 or
#' more deaths, Magnitude 7.5 or greater, Modified Mercalli Intensity X or
#' greater, or the earthquake generated a tsunami.
#' @format A data frame with 6065 rows and 47 variables:
#' \describe{
#' \item{\code{I_D}}{integer The unique numeric identifier of the record.}
#' \item{\code{FLAG_TSUNAMI}}{character When a tsunami was generated by
#' an earthquake, "Tsu" appears in the Assoc Tsu column. There should also
#' be a "TSU" link in the Assoc column which is linked to the tsunami
#' event database. The TSU link will display additional tsunami event
#' information in a new browser window.}
#' \item{\code{YEAR}}{integer Format +/-yyyy (-is B.C, +is A.D.)
#' The Date and Time are given in Universal Coordinated Time (also known
#' as Greenwich Mean Time). The local date may be one day different.}
#' \item{\code{MONTH}}{integer Valid values: 1-12}
#' \item{\code{DAY}}{integer Valid values: 1-31 (where months apply)}
#' \item{\code{HOUR}}{integer Valid values: 0-23}
#' \item{\code{MINUTE}}{integer Valid values: 0-59}
#' \item{\code{SECOND}}{character Valid values: 0-59}
#' \item{\code{FOCAL_DEPTH}}{integer Valid values: 0 to 700 km
#' The depth of the earthquake is given in kilometers.}
#' \item{\code{EQ_PRIMARY}}{double Valid values: 0.0 to 9.9
#' The value in this column contains the primary earthquake magnitude.
#' Magnitude measures the energy released at the source of the earthquake.}
#' \item{\code{EQ_MAG_MW}}{double Valid values: 0.0 to 9.9
#' The Mw magnitude is based on the moment magnitude scale. Moment is a
#' physical quantity proportional to the slip on the fault times the area
#' of the fault surface that slips; it is related to the total energy
#' released in the EQ.}
#' \item{\code{EQ_MAG_MS}}{double Valid values: 0.0 to 9.9
#' The Ms magnitude is the surface-wave magnitude of the earthquake.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_MB}}{character Valid values: 0.0 to 9.9
#' The Mb magnitude is the compressional body wave (P-wave) magnitude.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_ML}}{double Valid values: 0.0 to 9.9
#' The ML magnitude was the original magnitude relationship defined by
#' Richter and Gutenberg for local earthquakes in 1935.}
#' \item{\code{EQ_MAG_MFA}}{character Valid values: 0.0 to 9.9
#' The Mfa magnitudes are computed from the felt area, for earthquakes
#' that occurred before seismic instruments were in general use.}
#' \item{\code{EQ_MAG_UNK}}{double Valid values: 0.0 to 9.9
#' The computational method for the earthquake magnitude was unknown and
#' could not be determined from the published sources.}
#' \item{\code{INTENSITY}}{integer Valid values: 1 to 12
#' The Modified Mercalli Intensity (Int) is given in Roman Numerals
#' (converted to numbers in the digital database).}
#' \item{\code{COUNTRY}}{character The Country where the Earthquake
#' occurred}
#' \item{\code{STATE}}{character The two-letter State or
#' Province abbreviation where the Earthquake occurred.}
#' \item{\code{LOCATION_NAME}}{character The Country, State, Province or City
#' where the Earthquake occurred. This is only an approximate geographic
#' location. Events prior to 1900 were not instrumentally located,
#' therefore, the location given is based on the latitude and longitude of
#' the city where the damage occurred.}
#' \item{\code{LATITUDE}}{double Valid values: -90 to +90
#' Latitude: 0 to 90 (Northern Hemisphere) -90 to 0 (Southern Hemisphere)}
#' \item{\code{LONGITUDE}}{double Valid values: -180 to +180
#' Longitude: 0 to 180 (Eastern Hemisphere) -180 to 0 (Western Hemisphere)}
#' \item{\code{REGION_CODE}}{integer Regional boundaries defined as follows:
#' 10 = Central, Western and S. Africa
#' 15 = Northern Africa
#' 20 = Antarctica
#' 30 = East Asia
#' 40 = Central Asia and Caucasus
#' 50 = Kamchatka and Kuril Islands
#' 60 = S. and SE. Asia and Indian Ocean
#' 70 = Atlantic Ocean
#' 80 = Bering Sea
#' 90 = Caribbean
#' 100 = Central America
#' 110 = Eastern Europe
#' 120 = Northern and Western Europe
#' 130 = Southern Europe
#' 140 = Middle East
#' 150 = North America and Hawaii
#' 160 = South America
#' 170 = Central and South Pacific}
#' \item{\code{DEATHS}}{integer Valid values: 0 to 1100000}
#' \item{\code{DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{MISSING}}{character Valid values: 0 to 1100000}
#' \item{\code{MISSING_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{INJURIES}}{integer Valid values: 0 to 30000}
#' \item{\code{INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{DAMAGE_MILLIONS_DOLLARS}}{character Damage in Millions of
#' Dollars from the Earthquake: The value in the Damage column should be
#' multipled by 1,000,000 to obtain the actual dollar amount.}
#' \item{\code{DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses destroyed,
#' the following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage and was
#' listed.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_DEATHS}}{integer Valid values: 0 to 1100000
#' Total number of deaths from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths, this value was coded and listed.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{TOTAL_MISSING}}{character Valid values: 0 to 1100000
#' Whenever possible, total number of missing from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_MISSING_DESCRIPTION}}{character Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{TOTAL_INJURIES}}{integer Valid values: 0 to 30000
#' Whenever possible, total number of injuries from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{TOTAL_DAMAGE_MILLIONS_DOLLARS}}{character The value in the
#' Damage column should be multipled by 1,000,000 to obtain the actual
#' dollar amount. When a dollar amount for damage was found in the
#' literature, it was listed in the Damage column in millions of U.S.
#' dollars.}
#' \item{\code{TOTAL_DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{TOTAL_HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses destroyed, the
#' following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#'}
#' @source \url{https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1}
"Earthquakes"
#' @title Example 1. Cleaned dataset
#' @description Example dataset of eq_clean_data(data = Earthquakes)
#' @format A data frame with 5508 rows and 11 variables:
#' \describe{
#' \item{\code{I_D}}{integer The unique numeric identifier of the record.}
#' \item{\code{FLAG_TSUNAMI}}{character When a tsunami was generated by
#' an earthquake, "Tsu" appears in the Assoc Tsu column. There should also
#' be a "TSU" link in the Assoc column which is linked to the tsunami
#' event database. The TSU link will display additional tsunami event
#' information in a new browser window.}
#' \item{\code{FOCAL_DEPTH}}{integer Valid values: 0 to 700 km
#' The depth of the earthquake is given in kilometers.}
#' \item{\code{EQ_PRIMARY}}{double Valid values: 0.0 to 9.9
#' The value in this column contains the primary earthquake magnitude.
#' Magnitude measures the energy released at the source of the earthquake.}
#' \item{\code{EQ_MAG_MW}}{double Valid values: 0.0 to 9.9
#' The Mw magnitude is based on the moment magnitude scale. Moment is a
#' physical quantity proportional to the slip on the fault times the area
#' of the fault surface that slips; it is related to the total energy
#' released in the EQ.}
#' \item{\code{EQ_MAG_MS}}{double Valid values: 0.0 to 9.9
#' The Ms magnitude is the surface-wave magnitude of the earthquake.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_MB}}{character Valid values: 0.0 to 9.9
#' The Mb magnitude is the compressional body wave (P-wave) magnitude.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_ML}}{double Valid values: 0.0 to 9.9
#' The ML magnitude was the original magnitude relationship defined by
#' Richter and Gutenberg for local earthquakes in 1935.}
#' \item{\code{EQ_MAG_MFA}}{character Valid values: 0.0 to 9.9
#' The Mfa magnitudes are computed from the felt area, for earthquakes
#' that occurred before seismic instruments were in general use.}
#' \item{\code{EQ_MAG_UNK}}{double Valid values: 0.0 to 9.9
#' The computational method for the earthquake magnitude was unknown and
#' could not be determined from the published sources.}
#' \item{\code{INTENSITY}}{integer Valid values: 1 to 12
#' The Modified Mercalli Intensity (Int) is given in Roman Numerals
#' (converted to numbers in the digital database).}
#' \item{\code{COUNTRY}}{character The Country where the Earthquake
#' occurred}
#' \item{\code{STATE}}{character The two-letter State or
#' Province abbreviation where the Earthquake occurred.}
#' \item{\code{LOCATION_NAME}}{character The Country, State, Province or City
#' where the Earthquake occurred. This is only an approximate geographic
#' location. Events prior to 1900 were not instrumentally located,
#' therefore, the location given is based on the latitude and longitude of
#' the city where the damage occurred.}
#' \item{\code{LATITUDE}}{double Valid values: -90 to +90
#' Latitude: 0 to 90 (Northern Hemisphere) -90 to 0 (Southern Hemisphere)}
#' \item{\code{LONGITUDE}}{double Valid values: -180 to +180
#' Longitude: 0 to 180 (Eastern Hemisphere) -180 to 0 (Western Hemisphere)}
#' \item{\code{REGION_CODE}}{integer Regional boundaries defined as follows:
#' 10 = Central, Western and S. Africa
#' 15 = Northern Africa
#' 20 = Antarctica
#' 30 = East Asia
#' 40 = Central Asia and Caucasus
#' 50 = Kamchatka and Kuril Islands
#' 60 = S. and SE. Asia and Indian Ocean
#' 70 = Atlantic Ocean
#' 80 = Bering Sea
#' 90 = Caribbean
#' 100 = Central America
#' 110 = Eastern Europe
#' 120 = Northern and Western Europe
#' 130 = Southern Europe
#' 140 = Middle East
#' 150 = North America and Hawaii
#' 160 = South America
#' 170 = Central and South Pacific}
#' \item{\code{DEATHS}}{integer Valid values: 0 to 1100000}
#' \item{\code{DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{MISSING}}{character Valid values: 0 to 1100000}
#' \item{\code{MISSING_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{INJURIES}}{integer Valid values: 0 to 30000}
#' \item{\code{INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{DAMAGE_MILLIONS_DOLLARS}}{character Damage in Millions of
#' Dollars from the Earthquake: The value in the Damage column should be
#' multipled by 1,000,000 to obtain the actual dollar amount.}
#' \item{\code{DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses destroyed,
#' the following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage and was
#' listed.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_DEATHS}}{integer Valid values: 0 to 1100000
#' Total number of deaths from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths, this value was coded and listed.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{TOTAL_MISSING}}{character Valid values: 0 to 1100000
#' Whenever possible, total number of missing from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_MISSING_DESCRIPTION}}{character Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{TOTAL_INJURIES}}{integer Valid values: 0 to 30000
#' Whenever possible, total number of injuries from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{TOTAL_DAMAGE_MILLIONS_DOLLARS}}{character The value in the
#' Damage column should be multipled by 1,000,000 to obtain the actual
#' dollar amount. When a dollar amount for damage was found in the
#' literature, it was listed in the Damage column in millions of U.S.
#' dollars.}
#' \item{\code{TOTAL_DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{TOTAL_HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses destroyed, the
#' following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{DATE}}{Date Format year/month/day, year can be negative
#' (-is B.C), or positive (+is A.D.).}
#'}
#' @source \url{https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1}
"cleanES_1"
#' @title Example 2. Cleaned dataset
#' @description Example dataset of eq_clean_data(data = Earthquakes,
#' r.na = FALSE)
#' @format A data frame with 6065 rows and 11 variables:
#' \describe{
#' \item{\code{I_D}}{integer The unique numeric identifier of the record.}
#' \item{\code{FLAG_TSUNAMI}}{character When a tsunami was generated by
#' an earthquake, "Tsu" appears in the Assoc Tsu column. There should also
#' be a "TSU" link in the Assoc column which is linked to the tsunami
#' event database. The TSU link will display additional tsunami event
#' information in a new browser window.}
#' \item{\code{FOCAL_DEPTH}}{integer Valid values: 0 to 700 km
#' The depth of the earthquake is given in kilometers.}
#' \item{\code{EQ_PRIMARY}}{double Valid values: 0.0 to 9.9
#' The value in this column contains the primary earthquake magnitude.
#' Magnitude measures the energy released at the source of the earthquake.}
#' \item{\code{EQ_MAG_MW}}{double Valid values: 0.0 to 9.9
#' The Mw magnitude is based on the moment magnitude scale. Moment is a
#' physical quantity proportional to the slip on the fault times the area
#' of the fault surface that slips; it is related to the total energy
#' released in the EQ.}
#' \item{\code{EQ_MAG_MS}}{double Valid values: 0.0 to 9.9
#' The Ms magnitude is the surface-wave magnitude of the earthquake.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_MB}}{character Valid values: 0.0 to 9.9
#' The Mb magnitude is the compressional body wave (P-wave) magnitude.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_ML}}{double Valid values: 0.0 to 9.9
#' The ML magnitude was the original magnitude relationship defined by
#' Richter and Gutenberg for local earthquakes in 1935.}
#' \item{\code{EQ_MAG_MFA}}{character Valid values: 0.0 to 9.9
#' The Mfa magnitudes are computed from the felt area, for earthquakes
#' that occurred before seismic instruments were in general use.}
#' \item{\code{EQ_MAG_UNK}}{double Valid values: 0.0 to 9.9
#' The computational method for the earthquake magnitude was unknown and
#' could not be determined from the published sources.}
#' \item{\code{INTENSITY}}{integer Valid values: 1 to 12
#' The Modified Mercalli Intensity (Int) is given in Roman Numerals
#' (converted to numbers in the digital database).}
#' \item{\code{COUNTRY}}{character The Country where the Earthquake
#' occurred}
#' \item{\code{STATE}}{character The two-letter State or
#' Province abbreviation where the Earthquake occurred.}
#' \item{\code{LOCATION_NAME}}{character The Country, State, Province or City
#' where the Earthquake occurred. This is only an approximate geographic
#' location. Events prior to 1900 were not instrumentally located,
#' therefore, the location given is based on the latitude and longitude of
#' the city where the damage occurred.}
#' \item{\code{LATITUDE}}{double Valid values: -90 to +90
#' Latitude: 0 to 90 (Northern Hemisphere) -90 to 0 (Southern Hemisphere)}
#' \item{\code{LONGITUDE}}{double Valid values: -180 to +180
#' Longitude: 0 to 180 (Eastern Hemisphere) -180 to 0 (Western Hemisphere)}
#' \item{\code{REGION_CODE}}{integer Regional boundaries defined as follows:
#' 10 = Central, Western and S. Africa
#' 15 = Northern Africa
#' 20 = Antarctica
#' 30 = East Asia
#' 40 = Central Asia and Caucasus
#' 50 = Kamchatka and Kuril Islands
#' 60 = S. and SE. Asia and Indian Ocean
#' 70 = Atlantic Ocean
#' 80 = Bering Sea
#' 90 = Caribbean
#' 100 = Central America
#' 110 = Eastern Europe
#' 120 = Northern and Western Europe
#' 130 = Southern Europe
#' 140 = Middle East
#' 150 = North America and Hawaii
#' 160 = South America
#' 170 = Central and South Pacific}
#' \item{\code{DEATHS}}{integer Valid values: 0 to 1100000}
#' \item{\code{DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{MISSING}}{character Valid values: 0 to 1100000}
#' \item{\code{MISSING_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{INJURIES}}{integer Valid values: 0 to 30000}
#' \item{\code{INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{DAMAGE_MILLIONS_DOLLARS}}{character Damage in Millions of
#' Dollars from the Earthquake: The value in the Damage column should be
#' multipled by 1,000,000 to obtain the actual dollar amount.}
#' \item{\code{DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses destroyed,
#' the following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage and was
#' listed.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_DEATHS}}{integer Valid values: 0 to 1100000
#' Total number of deaths from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths, this value was coded and listed.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{TOTAL_MISSING}}{character Valid values: 0 to 1100000
#' Whenever possible, total number of missing from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_MISSING_DESCRIPTION}}{character Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{TOTAL_INJURIES}}{integer Valid values: 0 to 30000
#' Whenever possible, total number of injuries from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{TOTAL_DAMAGE_MILLIONS_DOLLARS}}{character The value in the
#' Damage column should be multipled by 1,000,000 to obtain the actual
#' dollar amount. When a dollar amount for damage was found in the
#' literature, it was listed in the Damage column in millions of U.S.
#' dollars.}
#' \item{\code{TOTAL_DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{TOTAL_HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses destroyed, the
#' following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{DATE}}{Date Format year/month/day, year can be negative
#' (-is B.C), or positive (+is A.D.).}
#'}
#' @source \url{https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1}
"cleanES_2"
#' @title Example 3. Cleaned dataset
#' @description Example dataset of eq_location_data(data = Earthquakes)
#' @format A data frame with 6065 rows and 47 variables:
#' \describe{
#' \item{\code{I_D}}{integer The unique numeric identifier of the record.}
#' \item{\code{FLAG_TSUNAMI}}{character When a tsunami was generated by
#' an earthquake, "Tsu" appears in the Assoc Tsu column. There should also
#' be a "TSU" link in the Assoc column which is linked to the tsunami
#' event database. The TSU link will display additional tsunami event
#' information in a new browser window.}
#' \item{\code{YEAR}}{integer Format +/-yyyy (-is B.C, +is A.D.)
#' The Date and Time are given in Universal Coordinated Time (also known
#' as Greenwich Mean Time). The local date may be one day different.}
#' \item{\code{MONTH}}{integer Valid values: 1-12}
#' \item{\code{DAY}}{integer Valid values: 1-31 (where months apply)}
#' \item{\code{HOUR}}{integer Valid values: 0-23}
#' \item{\code{MINUTE}}{integer Valid values: 0-59}
#' \item{\code{SECOND}}{character Valid values: 0-59}
#' \item{\code{FOCAL_DEPTH}}{integer Valid values: 0 to 700 km
#' The depth of the earthquake is given in kilometers.}
#' \item{\code{EQ_PRIMARY}}{double Valid values: 0.0 to 9.9
#' The value in this column contains the primary earthquake magnitude.
#' Magnitude measures the energy released at the source of the earthquake.}
#' \item{\code{EQ_MAG_MW}}{double Valid values: 0.0 to 9.9
#' The Mw magnitude is based on the moment magnitude scale. Moment is a
#' physical quantity proportional to the slip on the fault times the area
#' of the fault surface that slips; it is related to the total energy
#' released in the EQ.}
#' \item{\code{EQ_MAG_MS}}{double Valid values: 0.0 to 9.9
#' The Ms magnitude is the surface-wave magnitude of the earthquake.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_MB}}{character Valid values: 0.0 to 9.9
#' The Mb magnitude is the compressional body wave (P-wave) magnitude.
#' The magnitude is a measure of seismic energy. The magnitude scale is
#' logarithmic. An increase of one in magnitude represents a tenfold
#' increase in the recorded wave amplitude.}
#' \item{\code{EQ_MAG_ML}}{double Valid values: 0.0 to 9.9
#' The ML magnitude was the original magnitude relationship defined by
#' Richter and Gutenberg for local earthquakes in 1935.}
#' \item{\code{EQ_MAG_MFA}}{character Valid values: 0.0 to 9.9
#' The Mfa magnitudes are computed from the felt area, for earthquakes
#' that occurred before seismic instruments were in general use.}
#' \item{\code{EQ_MAG_UNK}}{double Valid values: 0.0 to 9.9
#' The computational method for the earthquake magnitude was unknown and
#' could not be determined from the published sources.}
#' \item{\code{INTENSITY}}{integer Valid values: 1 to 12
#' The Modified Mercalli Intensity (Int) is given in Roman Numerals
#' (converted to numbers in the digital database).}
#' \item{\code{COUNTRY}}{character The Country where the Earthquake
#' occurred}
#' \item{\code{STATE}}{character The two-letter State or
#' Province abbreviation where the Earthquake occurred.}
#' \item{\code{LOCATION_NAME}}{character The State, Province or City
#' where the Earthquake occurred. This is only an approximate geographic
#' location. Events prior to 1900 were not instrumentally located,
#' therefore, the location given is based on the latitude and longitude of
#' the city where the damage occurred.}
#' \item{\code{LATITUDE}}{double Valid values: -90 to +90
#' Latitude: 0 to 90 (Northern Hemisphere) -90 to 0 (Southern Hemisphere)}
#' \item{\code{LONGITUDE}}{double Valid values: -180 to +180
#' Longitude: 0 to 180 (Eastern Hemisphere) -180 to 0 (Western Hemisphere)}
#' \item{\code{REGION_CODE}}{integer Regional boundaries defined as follows:
#' 10 = Central, Western and S. Africa
#' 15 = Northern Africa
#' 20 = Antarctica
#' 30 = East Asia
#' 40 = Central Asia and Caucasus
#' 50 = Kamchatka and Kuril Islands
#' 60 = S. and SE. Asia and Indian Ocean
#' 70 = Atlantic Ocean
#' 80 = Bering Sea
#' 90 = Caribbean
#' 100 = Central America
#' 110 = Eastern Europe
#' 120 = Northern and Western Europe
#' 130 = Southern Europe
#' 140 = Middle East
#' 150 = North America and Hawaii
#' 160 = South America
#' 170 = Central and South Pacific}
#' \item{\code{DEATHS}}{integer Valid values: 0 to 1100000}
#' \item{\code{DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{MISSING}}{character Valid values: 0 to 1100000}
#' \item{\code{MISSING_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{INJURIES}}{integer Valid values: 0 to 30000}
#' \item{\code{INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{DAMAGE_MILLIONS_DOLLARS}}{character Damage in Millions of
#' Dollars from the Earthquake: The value in the Damage column should be
#' multipled by 1,000,000 to obtain the actual dollar amount.}
#' \item{\code{DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses destroyed,
#' the following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage and was
#' listed.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_DEATHS}}{integer Valid values: 0 to 1100000
#' Total number of deaths from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_DEATHS_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of
#' an actual number of deaths, this value was coded and listed.
#' 0 = None
#' 1 = Few (~1 to 50 deaths)
#' 2 = Some (~51 to 100 deaths)
#' 3 = Many (~101 to 1000 deaths)
#' 4 = Very Many (~1001 or more deaths)}
#' \item{\code{TOTAL_MISSING}}{character Valid values: 0 to 1100000
#' Whenever possible, total number of missing from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_MISSING_DESCRIPTION}}{character Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of missing.
#' 0 = None
#' 1 = Few (~1 to 50 missing)
#' 2 = Some(~51 to 100 missing)
#' 3 = Many (~101 to 1000 missing)
#' 4 = Very Many (~1001 or more missing)}
#' \item{\code{TOTAL_INJURIES}}{integer Valid values: 0 to 30000
#' Whenever possible, total number of injuries from the earthquake and
#' secondary effects.}
#' \item{\code{TOTAL_INJURIES_DESCRIPTION}}{integer Valid values: 0 to 4
#' When a description was found in the historical literature instead of an
#' actual number of injuries.
#' 0 = None
#' 1 = Few (~1 to 50 injuries)
#' 2 = Some(~51 to 100 injuries)
#' 3 = Many (~101 to 1000 injuries)
#' 4 = Very Many (~1001 or more injuries)}
#' \item{\code{TOTAL_DAMAGE_MILLIONS_DOLLARS}}{character The value in the
#' Damage column should be multipled by 1,000,000 to obtain the actual
#' dollar amount. When a dollar amount for damage was found in the
#' literature, it was listed in the Damage column in millions of U.S.
#' dollars.}
#' \item{\code{TOTAL_DAMAGE_DESCRIPTION}}{integer Valid values: 0 to 4
#' For those events not offering a monetary evaluation of damage, the
#' following five-level scale was used to classify damage (1990 dollars).
#' 0 = NONE
#' 1 = LIMITED (roughly corresponding to less than $1 million)
#' 2 = MODERATE (~$1 to $5 million)
#' 3 = SEVERE (~>$5 to $24 million)
#' 4 = EXTREME (~$25 million or more)}
#' \item{\code{TOTAL_HOUSES_DESTROYED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DESTROYED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses destroyed, the
#' following four-level scale was used to classify the destruction.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#' \item{\code{TOTAL_HOUSES_DAMAGED}}{integer Valid values: 0 to 1100000}
#' \item{\code{TOTAL_HOUSES_DAMAGED_DESCRIPTION}}{integer Valid values:
#' 0 to 4
#' For those events not offering an exact number of houses damaged, the
#' following four-level scale was used to classify the damage.
#' 0 = None
#' 1 = Few (~1 to 50 houses)
#' 2 = Some (~51 to 100 houses)
#' 3 = Many (~101 to 1000 houses)
#' 4 = Very Many (~1001 or more houses)}
#'}
#' @source \url{https://www.ngdc.noaa.gov/nndc/struts/form?t=101650&s=1&d=1}
"cleanES_3"
#' @title DATASET_TITLE
#' @description DATASET_DESCRIPTION
#' @format a character vector with 196 elements
"country_names"
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.