This repository hosts the code underlying Geocomputation with R, a book by Robin Lovelace, Jakub Nowosad, and Jannes Muenchow.
The online version of the book is developed at https://geocompr.robinlovelace.net/. We plan to publish the hard copy of the book with CRC Press in 2018.
We encourage contributions on any part of the book, including:
- Improvements to the text, e.g. clarifying unclear sentences, fixing typos (see guidance from Yihui Xie).
- Changes to the code, e.g. to do things in a more efficient way.
- Suggestions on content (see the project's issue tracker and the work-in-progress folder for chapters in the pipeline).
Please see our_style.md for the book's style.
Many thanks to all contributors to the book so far via GitHub (this list will update automatically): katygregg, rsbivand, pat-s, gisma, ateucher, yutannihilation, richfitz, gregor-d, p-kono, pokyah.
During the project we aim to contribute 'upstream' to the packages that make geocomputation with R possible. This impact is recorded in our-impact.csv
.
To ease reproducibility, this book is also a package. Installing it from GitHub will ensure all dependencies to build the book are available on your computer (you need devtools):
devtools::install_github("robinlovelace/geocompr")
You need a recent version of the GDAL, GEOS, Proj.4 and UDUNITS libraries installed for this to work on Mac and Linux. See the sf package's README for information on that.
Once the dependencies have been installed you should be able to build and view a local version the book with:
bookdown::render_book("index.Rmd") # to build the book
browseURL("_book/index.html") # to view it
The code associated with each chapter is saved in the code/chapters/
folder. source("code/chapters/07-transport.R")
runs run the code chunks in chapter 7, for example. These R scripts are generated with the follow command which wraps knitr::purl()
:
# geocompr:::generate_chapter_code()
To reduce the book's dependencies, scripts to be run infrequently to generate input for the book are run on creation of this README.
The additional packages required for this can be installed as follows:
source("code/extra-pkgs.R")
With these additional dependencies installed, you should be able to run the following scripts, which create content for the book, that we've removed from the main book build to reduce package dependencies and the book's build time:
source("code/cranlogs.R")
source("code/sf-revdep.R")
# source("code/09-usboundaries.R") # not working for some reason
source("code/09-urban-animation.R")
source("code/09-map-pkgs.R")
Note: the .Rproj
file is configured to build a website not a single page. To reproduce this README use the following command:
rmarkdown::render("README.Rmd", output_format = "github_document", output_file = "README.md")
An indication of the book's progress over time is illustrated below (to be updated roughly every week as the book progresses).
Book statistics: estimated number of pages per chapter over time.
To cite packages used in this book we use code from Efficient R Programming:
geocompr:::generate_citations()
This generates .bib and .csv files containing the packages. The current of packages used can be read-in as follows:
pkg_df = readr::read_csv("extdata/package_list.csv")
Other citations are stored online using Zotero.
If you would like to add to the references, please use Zotero, join the open group add your citation to the open geocompr library.
We use the following citation key format:
[auth:lower]_[veryshorttitle:lower]_[year]
This can be set from inside Zotero desktop with the Better Bibtex plugin installed (see github.com/retorquere/zotero-better-bibtex) by selecting the following menu options (with the shortcut Alt+E
followed by N
), and as illustrated in the figure below:
Edit > Preferences > Better Bibtex
We use Zotero because it is a powerful open source reference manager that integrates well with the citr package. As described in the GitHub repo Robinlovelace/rmarkdown-citr-demo.
knitr::kable(pkg_df)
Name | Title | version |
---|---|---|
bookdown | Authoring Books and Technical Documents with R Markdown [@R-bookdown] | 0.7 |
dismo | Species Distribution Modeling [@R-dismo] | 1.1.4 |
geosphere | Spherical Trigonometry [@R-geosphere] | 1.5.7 |
ggmap | Spatial Visualization with ggplot2 [@R-ggmap] | 2.6.1 |
ggplot2 | Create Elegant Data Visualisations Using the Grammar of Graphics [@R-ggplot2] | 2.2.1.9000 |
gstat | Spatial and Spatio-Temporal Geostatistical Modelling, Prediction [@R-gstat] | 1.1.6 |
historydata | Data Sets for Historians [@R-historydata] | 0.2.9001 |
htmlwidgets | HTML Widgets for R [@R-htmlwidgets] | 1.0 |
kableExtra | Construct Complex Table with 'kable' and Pipe Syntax [@R-kableExtra] | 0.8.0 |
knitr | A General-Purpose Package for Dynamic Report Generation in R [@R-knitr] | 1.20 |
leaflet | Create Interactive Web Maps with the JavaScript 'Leaflet' [@R-leaflet] | 1.1.0 |
link2GI | Linking Geographic Information Systems, Remote Sensing and Other [@R-link2GI] | 0.3.0 |
lwgeom | Bindings to Selected 'liblwgeom' Functions for Simple Features [@R-lwgeom] | 0.1.5 |
mapview | Interactive Viewing of Spatial Data in R [@R-mapview] | 2.3.0 |
microbenchmark | Accurate Timing Functions [@R-microbenchmark] | 1.4.4 |
mlr | Machine Learning in R [@R-mlr] | 2.13 |
osmdata | Import 'OpenStreetMap' Data as Simple Features or Spatial [@R-osmdata] | 0.0.6 |
pROC | Display and Analyze ROC Curves [@R-pROC] | 1.11.0 |
raster | Geographic Data Analysis and Modeling [@R-raster] | 2.6.7 |
rcartocolor | 'CARTOColors' Palettes [@R-rcartocolor] | 0.0.22 |
rgdal | Bindings for the 'Geospatial' Data Abstraction Library [@R-rgdal] | 1.2.18 |
rgeos | Interface to Geometry Engine - Open Source ('GEOS') [@R-rgeos] | 0.3.26 |
rmapshaper | Client for 'mapshaper' for 'Geospatial' Operations [@R-rmapshaper] | 0.4.0 |
rmarkdown | Dynamic Documents for R [@R-rmarkdown] | 1.9 |
rnaturalearth | World Map Data from Natural Earth [@R-rnaturalearth] | 0.1.0 |
rnaturalearthdata | World Vector Map Data from Natural Earth Used in 'rnaturalearth' [@R-rnaturalearthdata] | 0.1.0 |
RQGIS | Integrating R with QGIS [@R-RQGIS] | 1.0.3 |
RSAGA | SAGA Geoprocessing and Terrain Analysis [@R-RSAGA] | 1.0.0 |
sf | Simple Features for R [@R-sf] | 0.6.1 |
sp | Classes and Methods for Spatial Data [@R-sp] | 1.2.7 |
spData | Datasets for Spatial Analysis [@R-spData] | 0.2.8.5 |
spDataLarge | Large datasets for spatial analysis [@R-spDataLarge] | 0.2.6.1 |
stplanr | Sustainable Transport Planning [@R-stplanr] | 0.2.3.9000 |
tabularaster | Tidy Tools for 'Raster' Data [@R-tabularaster] | 0.4.0 |
tidyverse | Easily Install and Load the 'Tidyverse' [@R-tidyverse] | 1.2.1 |
tmap | Thematic Maps [@R-tmap] | 2.0 |
tmaptools | Thematic Map Tools [@R-tmaptools] | 2.0 |