Skip to content

Latest commit

 

History

History
136 lines (99 loc) · 7.04 KB

README.md

File metadata and controls

136 lines (99 loc) · 7.04 KB
Raw

Geocomputation with R

Build Status

Introduction

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 http://robinlovelace.net/geocompr/. We plan to publish the hard copy of the book with CRC Press in 2018.

Contributing

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.

Reproducing the book

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

Reproducing this README

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:

pkgs = c("cranlogs", "diagram", "globe", "tidytext")
to_install = !pkgs %in% installed.packages()
if(any(to_install)) {
  install.packages(pkgs[to_install])
}

With these additional dependencies installed, you should be able to run the following scripts, which create input figures for the book:

source("code/cranlogs.R")
source("code/sf-revdep.R")
source("code/sfr-class-diagram-gen.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 = "md_document", output_file = "README.md")

Book statistics

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.

Citations

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 and downloaded with:

geocompr:::dl_citations(f = "refs.bib", user = 418217, collection = "9K6FRP6N")

If you would like to add to the references, please use Zotero, join the open group add your citation to the open geocompr library.

References

knitr::kable(pkg_df)
Name Title version
bookdown Authoring Books and Technical Documents with R Markdown [@R-bookdown] 0.5
dismo Species Distribution Modeling [@R-dismo] 1.1.4
gstat Spatial and Spatio-Temporal Geostatistical Modelling, Prediction [@R-gstat] 1.1.5
htmlwidgets HTML Widgets for R [@R-htmlwidgets] 0.9
knitr A General-Purpose Package for Dynamic Report Generation in R [@R-knitr] 1.17
leaflet Create Interactive Web Maps with the JavaScript 'Leaflet' [@R-leaflet] 1.1.0
link2GI Linking GIS, Remote Sensing and Other Command Line Tools [@R-link2GI] 0.1.0
mapview Interactive Viewing of Spatial Objects in R [@R-mapview] 2.1.4
microbenchmark Accurate Timing Functions [@R-microbenchmark] 1.4.2.1
osmdata Import 'OpenStreetMap' Data as Simple Features or Spatial [@R-osmdata] 0.0.5
raster Geographic Data Analysis and Modeling [@R-raster] 2.5.8
rgdal Bindings for the 'Geospatial' Data Abstraction Library [@R-rgdal] 1.2.13
rgeos Interface to Geometry Engine - Open Source ('GEOS') [@R-rgeos] 0.3.25
rmarkdown Dynamic Documents for R [@R-rmarkdown] 1.6
rnaturalearth World Map Data from Natural Earth [@R-rnaturalearth] 0.1.0
RQGIS Integrating R with QGIS [@R-RQGIS] 1.0.1.9000
RSAGA SAGA Geoprocessing and Terrain Analysis in R [@R-RSAGA] 0.94.5
sf Simple Features for R [@R-sf] 0.5.5
sp Classes and Methods for Spatial Data [@R-sp] 1.2.5
spData Datasets for Spatial Analysis [@R-spData] 0.2.6.0
spDataLarge Large datasets for spatial analysis [@R-spDataLarge] 0.2.3.0
tabularaster Tidy Tools for 'Raster' Data [@R-tabularaster] 0.4.0
tidyverse Easily Install and Load 'Tidyverse' Packages [@R-tidyverse] 1.1.1
tmap Thematic Maps [@R-tmap] 1.10