isdas-package.R

#' @keywords internal
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL

#' isdas
#'
#' A package with data sets and functions used in the book _An Introduction to Spatial Data Analysis and Statistics: A Course in_ \code{R}.
#'
#' @author Antonio Paez, School of Earth, Environment and Society, McMaster University \email{paezha@@mcmaster.ca}
#' @name isdas-package
#' @docType package
#' @import deldir dplyr plotly sp spdep stats
#'
NULL

#' John Snow's London 1854 cholera outbreak deaths
#'
#' A dataset containing the location and number of cholera deaths in Soho, London.
#'  The variables are as follows:
#'
#' \itemize{
#'   \item long. longitude of address (\-0.1401--\-0.1329)
#'   \item lat. latitude of address (51.51--51.52)
#'   \item Id. Unique identifier of address
#'   \item Count. Number of deaths recorded at address (1--15)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name snow_deaths
#' @usage data(snow_deaths)
#' @format A data frame with 250 rows and 5 variables
#' @source \url{http://blog.rtwilson.com/?s=snow}
"snow_deaths"

#' John Snow's London 1854 cholera outbreak pumps
#'
#' A dataset containing the location of pumps in Soho, London.
#'  The variables are as follows:
#'
#' \itemize{
#'   \item long. longitude of address (\-0.1401--\-0.1329)
#'   \item lat. latitude of address (51.51--51.52)
#'   \item Id. Unique identifier of address
#'   \item Count. Number of pumps at location
#' }
#'
#' @docType data
#' @keywords datasets
#' @name snow_pumps
#' @usage data(snow_pumps)
#' @format A data frame with 5 rows and 4 variables
#' @source \url{http://blog.rtwilson.com/?s=snow}
"snow_pumps"

#' Hamilton Census Metropolitan Area (CMA) Disseminations Areas (DAs)
#'
#' A simple feature (sf) dataframe of Hamilton Census Metropolitan Area (CMA) Dissemination Areas (DAs) with some generic variables.  The projection is: EPSG: 26917 proj4string: "+proj=utm +zone=17 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs". The generic variables were simulated by A. Paez based Moran Eigenvectors.
#'
#'  The variables are as follows:
#'
#' \itemize{
#'    \item ID. Unique Identifier for the area
#'    \item GTA06. Unique Identifier for DA according to the Transportation Tomorrow Survey GTA06 geography
#'    \item VAR 1. Varible used to create a thematic map (0.3788377--0.3482670)
#'    \item VAR 2. Varible used to create a thematic map (0.3418337--0.4953046)
#'    \item VAR 3. Varible used to create a thematic map (0.3450731--0.2735642)
#'    \item VAR 4. Varible used to create a thematic map (0.3057122--0.4634048)
#'    \item VAR 5. Varible used to create a thematic map (0.3622016--0.4760264)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name HamiltonDAs
#' @usage data(HamiltonDAs)
#' @format A data frame with 297 rows and 8 variables
#' @source \url{https://www12.statcan.gc.ca/census-recensement/2011/geo/bound-limit/bound-limit-2011-eng.cfm}
"HamiltonDAs"

#' PointPattern1
#'
#' A dataset containing locations of some generic events.
#'  The variables are as follows:
#'
#' \itemize{
#'    \item x. x points based on a false origin and normalized to the unit-square for a generic variable like events as cases of flu, the location of trees of a certain species, or the location of fires (0.02849997--0.98884730)
#'    \item y. y points based on a false origin and normalized to the unit-square for a generic variable like events as cases of flu, the location of trees of a certain species, or the location of fires (0.005306043--0.999807645)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name PointPattern1
#' @usage data(PointPattern1)
#' @format A data frame with 60 rows and 2 variables
#' @source Extracted from Data2.RData file
"PointPattern1"

#' PointPattern2
#'
#' A dataset containing locations of some generic events.
#'  The variables are as follows:
#'
#' \itemize{
#'    \item x. x points based on a false origin and normalized to the unit-square for a generic variable like events as cases of flu, the location of trees of a certain species, or the location of fires (0.01689682--0.99900765)
#'    \item y. y points based on a false origin and normalized to the unit-square for a generic variable like events as cases of flu, the location of trees of a certain species, or the location of fires (0.02932253--0.98867308)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name PointPattern2
#' @usage data(PointPattern2)
#' @format A data frame with 60 rows and 2 variables
#' @source Extracted from Data2.RData file
"PointPattern2"

#' PointPattern3
#'
#' A dataset containing locations of some generic events.
#'
#' \itemize{
#'    \item x. x points based on a false origin and normalized to the unit-square for a generic variable like events as cases of flu, the location of trees of a certain species, or the location of fires (0.04911492--0.98371039)
#'    \item y. y points based on a false origin and normalized to the unit-square for a generic variable like events as cases of flu, the location of trees of a certain species, or the location of fires (0.01036480--0.99283927)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name PointPattern3
#' @usage data(PointPattern3)
#' @format A data frame with 60 rows and 2 variables
#' @source Extracted from Data2.RData file
"PointPattern3"

#' A selection of fast food establishments in the Toronto area
#'
#' A simple feature (sf) dataframe containing the locations selected locations of fast food restaruants in Toronto (data are from 2008). The projection is: EPSG: 26917 proj4string: "+proj=utm +zone=17 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs".
#'
#' \itemize{
#'    \item Class. Four types of food offered at fast food restaurants in Toronto (Chicken, Hamburger, Pizza, Sub)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name Fast_Food
#' @usage data(Fast_Food)
#' @format A data frame with 614 rows and 3 variables
#' @source Extracted from Toronto Business Points.RData
"Fast_Food"

#' Gas stands in the Toronto area
#'
#' A simple feature (sf) dataframe containing the locations of gas stands in Toronto (data are from 2008). The projection is: EPSG: 26917 proj4string: "+proj=utm +zone=17 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs".
#'
#' @docType data
#' @keywords datasets
#' @name Gas_Stands
#' @usage data(Gas_Stands)
#' @format A data frame with 345 rows ad 2 variables
#' @source Extracted from Toronto Business Points.RData
"Gas_Stands"

#' A set of points with proposed Paez Mart locations
#'
#' A simple feature (sf) dataframe containing planned locations of convenience stores in Toronto. The projection is: EPSG: 26917 proj4string: "+proj=utm +zone=17 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs".
#'
#' @docType data
#' @keywords datasets
#' @name Paez_Mart
#' @usage data(Paez_Mart)
#' @format A data frame with 395 rows and 3 variables
#' @source Locations proposed by A. Paez
"Paez_Mart"

#' Toronto
#'
#' A simple feature (sf) dataframe of Toronto City boundaries. The projection is: EPSG: 26917 proj4string: "+proj=utm +zone=17 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs".
#'
#' @docType data
#' @keywords datasets
#' @name Toronto
#' @usage data(Toronto)
#' @format sf object with 1 observation of 1 variable (only geometry)
#' @source \url{https://www12.statcan.gc.ca/census-recensement/2011/geo/bound-limit/bound-limit-2011-eng.cfm}
"Toronto"

#' bear_df
#'
#' A dataset containing spatial information from the Scandinavian Bear Project which is a Swedish-Noruegian collaboration that aims to study the ecology of brown bears, to provide decision makers with evidence to support bear management, and to provide information regarding bears to the public.
#'  The variables are as follows:
#'
#'  \itemize{
#'    \item x. list of x-coordinates used to plot location of bears during the day and night (515743.2--522999.4)
#'    \item y. list of y-coordinates used to plot location of bears during the day and night (6812138--6821440)
#'    \item marks. Unique identifier of bear movement at different times (Day Time, Night Time)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name bear_df
#' @usage data(bear_df)
#' @format A data frame with 1000 rows and 3 variables
#' @source \url{https://www.brownbearproject.com/about-the-project}
"bear_df"

#' pp0_df
#'
#' A sample dataset with a point pattern with two sets of spatial events, labeled as "Pattern 1" and "Pattern 2".
#'
#'  \itemize{
#'    \item x. list of x-coordinates used to plot two sets of spatial events (0.04559819--0.95643341)
#'    \item y. list of y-coordinates used to plot two sets of spatial events (0.03408578--0.94492099)
#'    \item marks. Two sets of spatial events (Pattern 1, Pattern 2)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name pp0_df
#' @usage data(pp0_df)
#' @format A data frame with 72 rows and 3 variables
#' @source Data simulated by A. Paez
"pp0_df"

#' pp1_df
#'
#' A sample dataset with a point pattern.
#'
#'  \itemize{
#'    \item x. list of x-coordinates (0.01321246--0.96299812)
#'    \item y. list of y-coordinates (0.02570673--0.84147945)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name pp1_df
#' @usage data(pp1_df)
#' @format A data frame with 81 rows and 2 variables
#' @source Data simulated by A. Paez
"pp1_df"


#' pp2_df
#'
#' A sample dataset with a point pattern.
#'
#'  \itemize{
#'    \item x. list of x-coordinates (0.01321246--0.96299812)
#'    \item y. list of y-coordinates (0.02570673--0.84147945)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name pp2_df
#' @usage data(pp2_df)
#' @format A data frame with 81 rows and 2 variables
#' @source Data simulated by A. Paez
"pp2_df"

#' pp3_df
#'
#' A sample dataset with a point pattern.
#'
#'  \itemize{
#'    \item x. list of x-coordinates (0.1035079--0.8741389)
#'    \item y. list of y-coordinates (0.1015268--0.8725456)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name pp3_df
#' @usage data(pp3_df)
#' @format A data frame with 81 rows and 2 variables
#' @source Data simulated by A. Paez
"pp3_df"

#' pp4_df
#'
#' A sample dataset with a point pattern.
#'
#'  \itemize{
#'    \item x. list of x-coordinates (0.1945629--0.9624404)
#'    \item y. list of y-coordinates (0.02639242--0.88419944)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name pp4_df
#' @usage data(pp4_df)
#' @format A data frame with 81 rows and 2 variables
#' @source Data simulated by A. Paez
"pp4_df"

#' pp5_df
#'
#' A sample dataset with a point pattern.
#'
#'  \itemize{
#'    \item x. list of x-coordinates (0.16--0.88)
#'    \item y. list of y-coordinates (0.16--0.88)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name pp5_df
#' @usage data(pp5_df)
#' @format A data frame with 81 rows and 2 variables
#' @source Data simulated by A. Paez
"pp5_df"

#' missing_df
#'
#' A dataframe containing a set of observations, including some with missing variables.
#'  The variables are as follows:
#'
#' \itemize{
#'    \item x. x points based on a false origin and normalized to the unit-square  (0.01698944--0.95718825)
#'    \item y. y points based on a false origin and normalized to the unit-square  (0.01003585--0.98715473)
#'    \item VAR1. Genric variable - think of it as housing prices or concentrations in ppb of some contaminant (50.00000--1050.00000)
#'    \item VAR2. Genric variable - think of it as housing prices or concentrations in ppb of some contaminant (50.00000--1050.00000)
#'    \item VAR3. Genric variable - think of it as housing prices or concentrations in ppb of some contaminant (50.00000--1050.00000)
#'    \item Observed. factor variable states whether the variables were measured for a location: if the status is "FALSE", the values of the variables are missing (TRUE--FALSE)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name missing_df
#' @usage data(missing_df)
#' @format A data frame with 65 rows and 6 variables
#' @source Data simulated by A. Paez
"missing_df"

#' PointPatterns
#'
#' A dataset which includess a dataframe with four sets of spatial events, labeled as "Pattern 1", "Pattern 2", "Pattern 3", "PointPattern4", with n = 60 events in each set.
#'  The variables are as follows:
#'
#' \itemize{
#'    \item x. x coordinates used to plot spatial event (0.01689682--0.99900765)
#'    \item y. y coordinates used to plot spatial event (0.005306043--0.999807645)
#'    \item Pattern. Four sets of spatial events (Pattern 1, Pattern 2, Pattern 3 and Pattern 4)
#' }
#'
#' @docType data
#' @keywords datasets
#' @name PointPatterns
#' @usage data(PointPatterns)
#' @format A data frame with 140 rows and 3 variables
#' @source Data simulated by A. Paez
"PointPatterns"

#' df1_simulated
#'
#' A dataframe with a simulated landscape.
#'
#'  \itemize{
#'    \item x. list of x-coordinates (1--87)
#'    \item y. list of y-coordinates (1--61)
#'    \item z. list of z-coordinates (24.39618--69.58580)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name df1_simulated
#' @usage data(df1_simulated)
#' @format A data frame with 350 rows and 3 variables
#' @source Data simulated by A. Paez
"df1_simulated"

#' df2_simulated
#'
#' A dataframe with a simulated landscape.
#'
#'  \itemize{
#'    \item x. list of x-coordinates (1--87)
#'    \item y. list of y-coordinates (1--61)
#'    \item z. list of z-coordinates (24.39618--69.58580)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name df2_simulated
#' @usage data(df2_simulated)
#' @format A data frame with 350 rows and 3 variables
#' @source Data simulated by A. Paez
"df2_simulated"

#' trips_by_mode
#'
#' An dataframe with the number of trips by mode of transportation by Traffic Analysis Zone (TAZ), and other useful information from the 2011 census for the Hamilton, CMA, Canada.
#'
#'  \itemize{
#'    \item GTA06. identifier used for spatial joins (4050--6020)
#'    \item Cycle. list of Hamiltonians that cycle to work (0--623)
#'    \item Auto_driver. list of Hamiltonians that drive to work (0--17743)
#'    \item Auto_passenger. list of Hamiltonians that get a ride to work (0--4321)
#'    \item Walk. list of Hamiltonians that walk to work (0--1599)
#'    \item Population. population based on a unique spatial polygon (38.88097--12770.552)
#'    \item Worked_in_2010_Full-time. number of Hamiltonians that worked full-time in 2010 (0--5925.9434)
#'    \item Worked_in_2010_Part-time. number of Hamiltonians that worked part-time in 2010 (0--1661.16313)
#'    \item Worked_at_home. number of Hamiltonians that worked from home (0--559.97542)
#'    \item Pop_Density. population denisty based on a unique spatial polygon (26.20745--14232.5677)
#'    \item Median_Age. median age of Hamiltonians based on a unique spatial polygon (3.845238--56.85006)
#'    \item Family_Size_2. size of family based on unique a spatial polygon (7.250167--1489.0255)
#'    \item Family_Size_3. size of family based on unique a spatial polygon (3.237384--859.09030)
#'    \item Family_Size_4. size of family based on unique a spatial polygon (1.619751--1281.18323)
#'    \item Family_Size_5_more. size of family based on a unique spatial polygon (1.617209--387.37487)
#'    \item Median_income. median income based on unique spatial polygon (9.496379--52496.09)
#'    \item Average_income. average income based on unique spatial polygon (11.44593--81235.73)
#'    \item Employment_rate. average employment rate based on a unique spatial polygon (32.74746--76.69758)
#'    \item Unemployment)rate. average unemployment rate based on a unique polygon (0.001258--23.200001)
#'    \item Median_commuting_duration. median commuting duration based on a unique polygon (15.41049--30.59950)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name trips_by_mode
#' @usage data(trips_by_mode)
#' @format An excel file with 270 rows and 20 variables
#' @source \url{http://www.transportationtomorrow.on.ca/}
#' @source \url{http://www12.statcan.gc.ca/census-recensement/index-eng.cfm}
"trips_by_mode"

#' "travel_time_car"
#'
#' A dataframe with travel distance/time from TAZ centroids to Jackson Square in downtown Hamilton, Canada.
#'
#'  \itemize{
#'    \item GTA06. idenitifer used for spatial joins (4050--6020)
#'    \item group. (4050.1--6020.1)
#'    \item from. TAZ centroid address
#'    \item to. Jackson Square, Hamilton, Ontario
#'    \item m. travel distance between origin and Jackson Square in meters (493--37558)
#'    \item km. travel distance between origin and Jackson Square in kilometers (0.493--37.558)
#'    \item miles. travel distance between origin and Jackson Square in miles (0.3063502--23.338541)
#'    \item seconds. travel time between origin and Jackson Square in seconds (115--2100)
#'    \item minutes. travel time between origin and Jackson Square in minutes (1.91667--35.0000)
#'    \item hours. travel time between origin and Jackson Square in hours (0.03194444--0.5833333)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name travel_time_car
#' @usage data(travel_time_car)
#' @format An excel file with 270 rows and 10 variables
#' @source Calculated by A. Paez
"travel_time_car"

#' Walker_Lake
#'
#' A dataset with geocoded observations of a series of variables originally used for teaching geostatistics in Isaaks and Srivastava's _An Introduction to Geostatistics_.
#'  The variables are as follows:
#'
#'  \itemize{
#'    \item ID. object ID of variable (1--470)
#'    \item X. false x-coordinates (8--251)
#'    \item Y. false y-coordinates (8--291)
#'    \item V. quantitative variable (0--1528.1)
#'    \item U. quantitative variable (0--5190.1)
#'    \item T. factor variable (1--2)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name Walker_Lake
#' @usage data(Walker_Lake)
#' @format A dataset with 470 rows and 6 variables
#' @source \url{https://books.google.ca/books/about/Applied_Geostatistics.html?id=vC2dcXFLI3YC&redir_esc=y}
"Walker_Lake"

#' aquifer
#'
#' A dataset of piezometric head (watertable pressure) observations of the Wolfcamp Aquifer in Texas. This dataset was used by Isaaks and Srivastavas in their book An Introduction to Applied Geostatistics.
#'
#'  \itemize{
#'    \item X. x-coordinates (\-145.23564\--112.80450)
#'    \item Y. y-coordiantes (9.41441--184.76636)
#'    \item H. Hydraulic head at the Woldcamp Aquifer in Texas (1024--3571)
#'}
#'
#' @docType data
#' @keywords datasets
#' @name aquifer
#' @usage data(aquifer)
#' @format A dataset with 85 rows and 3 variables
#' @source \url{https://rubenfcasal.github.io/npsp/reference/aquifer.html}
"aquifer"

#' nyleukemia
#'
#' A SpatialPolygonDataFrame of New York leukemia data projected in UTM Zone 18 using WGS84.
#'
#'  \itemize{
#'    \item AREANAME. name of study area (Auburn city--Vestal town)
#'    \item AREAKEY. unique identifier of study area (36007000100--36109992300)
#'    \item X. x-coordinates of spatial polygons (-55.482300--53.508600)
#'    \item Y. y-coordinates of spatial polygons (-75.290700--56.410130)
#'    \item POP8. (9--13015)
#'    \item TRACTCAS. (0.00--9.29)
#'    \item PROPCAS. (0.000000--0.006993)
#'    \item PCTOWNHOME. (0.00082237--1.0000000)
#'    \item PCTAGE65. (0.00404412--0.5050505)
#'    \item Z. (-1.92062--4.71053)
#'    \item AVGDIST. (0.0184667--3.5263750)
#'    \item PEXPOSURE. (0.613384--5.865441)
#'    \item Cases. number of leukemia cases in New York based on studya area (0.00014--9.286010)
#'    \item Xm. (-55482.300--53508.600)
#'    \item Ym. (-75290.700--56410.130)
#'    \item Xshift. (363839.3--472830.2)
#'    \item Yshift. (4653564--4785265)
#'}
#'
#' @docType data
#' @keywords spatialpolygondataframe
#' @name nyleukemia
#' @usage data(nyleukemia)
#' @format A spatial polygon data frame with 281 rows and 17 variables
#' @source \url{https://www.rdocumentation.org/packages/SpatialEpi/versions/1.2.3/topics/NYleukemia}
"nyleukemia"

#' pennlc
#'
#' A SpatialPolygonDataFrame of Pennsylvania lung cancer projected using latitude and longitude.
#'
#'  \itemize{
#'    \item county. name of each county in Pennsylvania with recorded lung cancer patients within this spatial polygon data frame (adams--york)
#'    \item cases. number of cases in each county with lung cancer (3--1415)
#'    \item population. population of each county in Pennsylvania (4946--1517550)
#'    \item rate. (2.629157--13.391363)
#'    \item smoking. (0.182--0.279)
#'    \item cancer_rate. rate of patients diagnosed with lung cancer in each county of Pennsylvania (2.629157--13.391363)
#'    \item smoking_rate. smoking rate per county in Pennsylvania (18.2--27.9)
#'}
#'
#' @docType data
#' @keywords spatialpolygondataframe
#' @name pennlc
#' @usage data(pennlc)
#' @format A spatial polygon data frame with 67 rows and 7 variables
#' @source \url{https://www.rdocumentation.org/packages/RgoogleMaps/versions/1.4.2/topics/pennLC}
"pennlc"

#' Hamilton Census Tracts with select demographic information from the 2011 Census of Canada.
#'
#' A simple feature (sf) dataframe of Hamilton Census Metropolitan Area (CMA) Census Tracts (CTs) with demographic information from the 2011 Census. The projection is: EPSG: 26917 proj4string: "+proj=utm +zone=17 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs"
#'
#'  \itemize{
#'    \item ID. Unique Identifier of Area
#'    \item AREA. Area of CT in sq.km.
#'    \item TRACT. Unique Identifier of Census Tract
#'    \item POPULATION. 2011 Population count in Census Tract
#'    \item POP_DENSITY. Population density in Census Tract
#'    \item AGE_LESS_20. Population aged less than 20 years old
#'    \item AGE_20_TO_24. Population aged 20 to 24 years old
#'    \item AGE_25_TO_29. Population aged 25 to 29 years old
#'    \item AGE_30_TO_34. Population aged 30 to 34 years old
#'    \item AGE_34_TO_39. Population aged 35 to 39 years old
#'    \item AGE_40_TO_44. Population aged 40 to 44 years old
#'    \item AGE_45_TO_49. Population aged 45 to 49 years old
#'    \item AGE_50_TO_54. Population aged 50 to 54 years old
#'    \item AGE_55_TO_59. Population aged 54 to 59 years old
#'    \item AGE_60_TO_64. Population aged 60 to 64 years old
#'    \item AGE_65_TO_69. Population aged 65 to 69 years old
#'    \item AGE_70_TO_74. Population aged 70 to 74 years old
#'    \item AGE_75_TO_79. Population aged 75 to 79 years old
#'    \item AGE_80_TO_84. Population aged 80 to 84 years old
#'    \item AGE_MORE_85. Population aged 85 years and older
#'}
#'
#' @docType data
#' @keywords spatialpolygondataframe
#' @name Hamilton_CT
#' @usage data(Hamilton_CT)
#' @format A SpatialPolygonsDataDrame with 188 rows and 20 variables
#' @source \url{https://www12.statcan.gc.ca/census-recensement/2011/geo/bound-limit/bound-limit-2011-eng.cfm}
"Hamilton_CT"