https://github.com/cortinah/geocompr

Geocomputation with R: an open source book

https://github.com/cortinah/geocompr

Repository

Geocomputation with R: an open source book

https://github.com/cortinah/geocompr/blob/main/

# Geocomputation with R



[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geocompx/geocompr/main?urlpath=rstudio)
[![RstudioCloud](images/cloud.png)](https://rstudio.cloud/project/1642300)
[![Actions](https://github.com/geocompx/geocompr/workflows/Render/badge.svg)](https://github.com/geocompx/geocompr/actions)
[![Docker](https://img.shields.io/docker/pulls/geocompr/geocompr?style=plastic)](https://github.com/geocompx/docker/)
[![discord](https://img.shields.io/discord/878051191374876683?label=discord&logo=Discord&color=blue)](https://discord.com/invite/PMztXYgNxp)
[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=84222786&machine=basicLinux32gb&devcontainer_path=.devcontainer.json&location=WestEurope)



## Introduction

This repository hosts the code underlying Geocomputation with R, a book
by [Robin Lovelace](https://www.robinlovelace.net/), [Jakub
Nowosad](https://jakubnowosad.com/), and [Jannes
Muenchow](https://github.com/jannes-m). If you find the contents useful,
please [cite
it](https://github.com/geocompx/geocompr/raw/main/CITATION.bib) as
follows:

> Lovelace, Robin, Jakub Nowosad and Jannes Muenchow (2025).
> Geocomputation with R. The R Series. CRC Press.

To learn more about the second edition of the book, see the [Second
edition of Geocomputation with R is complete blog
post](https://geocompx.org/post/2024/geocompr2-bp3/).

The first version of the book has been published by [CRC
Press](https://www.crcpress.com/9781138304512) in the [R
Series](https://www.routledge.com/Chapman--HallCRC-The-R-Series/book-series/CRCTHERSER)
and can be viewed online at
[bookdown.org](https://bookdown.org/robinlovelace/geocompr/). Read the
latest version at [r.geocompx.org](https://r.geocompx.org/).






Contributions are very welcome.

## 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](https://yihui.org/en/2013/06/fix-typo-in-documentation/));
- changes to the code, e.g., to do things in a more efficient way;
- suggestions on content (see the projects [issue
  tracker](https://github.com/geocompx/geocompr/issues));
- improvements to and alternative approaches in the Geocompr solutions
  booklet hosted at
  [r.geocompx.org/solutions](https://r.geocompx.org/solutions) (see a
  blog post on how to update solutions in files such as
  [\_01-ex.Rmd](https://github.com/geocompx/geocompr/blob/main/_01-ex.Rmd)
  [here](https://geocompx.org/post/2022/geocompr-solutions/))

See
[our-style.md](https://github.com/geocompx/geocompr/blob/main/misc/our-style.md)
for the books style.

Many thanks to all contributors to the book so far via GitHub (this list
will update automatically): [prosoitos](https://github.com/prosoitos),
[tibbles-and-tribbles](https://github.com/tibbles-and-tribbles),
[florisvdh](https://github.com/florisvdh),
[babayoshihiko](https://github.com/babayoshihiko),
[katygregg](https://github.com/katygregg),
[Lvulis](https://github.com/Lvulis),
[rsbivand](https://github.com/rsbivand),
[iod-ine](https://github.com/iod-ine),
[KiranmayiV](https://github.com/KiranmayiV),
[cuixueqin](https://github.com/cuixueqin),
[defuneste](https://github.com/defuneste),
[smkerr](https://github.com/smkerr), [zmbc](https://github.com/zmbc),
[marcosci](https://github.com/marcosci),
[darrellcarvalho](https://github.com/darrellcarvalho),
[dcooley](https://github.com/dcooley),
[FlorentBedecarratsNM](https://github.com/FlorentBedecarratsNM),
[erstearns](https://github.com/erstearns),
[appelmar](https://github.com/appelmar),
[MikeJohnPage](https://github.com/MikeJohnPage),
[eyesofbambi](https://github.com/eyesofbambi),
[krystof236](https://github.com/krystof236),
[nickbearman](https://github.com/nickbearman),
[tylerlittlefield](https://github.com/tylerlittlefield),
[sdesabbata](https://github.com/sdesabbata),
[howardbaik](https://github.com/howardbaik),
[edzer](https://github.com/edzer), [pat-s](https://github.com/pat-s),
[giocomai](https://github.com/giocomai),
[KHwong12](https://github.com/KHwong12),
[LaurieLBaker](https://github.com/LaurieLBaker),
[eblondel](https://github.com/eblondel),
[MarHer90](https://github.com/MarHer90),
[mdsumner](https://github.com/mdsumner),
[ahmohil](https://github.com/ahmohil),
[richfitz](https://github.com/richfitz),
[VLucet](https://github.com/VLucet),
[wdearden](https://github.com/wdearden),
[yihui](https://github.com/yihui),
[adambhouston](https://github.com/adambhouston),
[chihinl](https://github.com/chihinl),
[cshancock](https://github.com/cshancock),
[e-clin](https://github.com/e-clin),
[ec-nebi](https://github.com/ec-nebi),
[gregor-d](https://github.com/gregor-d),
[jasongrahn](https://github.com/jasongrahn),
[p-kono](https://github.com/p-kono),
[pokyah](https://github.com/pokyah),
[schuetzingit](https://github.com/schuetzingit),
[tim-salabim](https://github.com/tim-salabim),
[tszberkowitz](https://github.com/tszberkowitz),
[vlarmet](https://github.com/vlarmet),
[ateucher](https://github.com/ateucher),
[annakrystalli](https://github.com/annakrystalli),
[andtheWings](https://github.com/andtheWings),
[kant](https://github.com/kant),
[gavinsimpson](https://github.com/gavinsimpson),
[Himanshuteli](https://github.com/Himanshuteli),
[yutannihilation](https://github.com/yutannihilation),
[jimr1603](https://github.com/jimr1603),
[jbixon13](https://github.com/jbixon13),
[jkennedyie](https://github.com/jkennedyie),
[olyerickson](https://github.com/olyerickson),
[yvkschaefer](https://github.com/yvkschaefer),
[katiejolly](https://github.com/katiejolly),
[kwhkim](https://github.com/kwhkim), [layik](https://github.com/layik),
[mpaulacaldas](https://github.com/mpaulacaldas),
[mtennekes](https://github.com/mtennekes),
[mvl22](https://github.com/mvl22),
[ganes1410](https://github.com/ganes1410).

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`](https://github.com/geocompx/geocompr/blob/main/misc/our-impact.csv).

## Downloading the source code

The recommended way to get the source code underlying Geocomputation
with R on your computer is by cloning the repo. You can can that on any
computer with [Git](https://github.com/git-guides/install-git) installed
with the following command:

``` bash
git clone https://github.com/geocompx/geocompr.git
```

An alternative approach, which we recommend for people who want to
contribute to open source projects hosted on GitHub, is to install the
[`gh` CLI tool](https://github.com/cli/cli#installation). From there
cloning a fork of the source code, that you can change and share
(including with Pull Requests to improve the book), can be done with the
following command:

``` bash
gh repo fork geocompx/geocompr # (gh repo clone geocompx/geocompr # also works)
```

Both of those methods require you to have Git installed. If not, you can
download the books source code from the URL
 .
Download/unzip the source code from the R command line to increase
reproducibility and reduce time spent clicking around:

``` r
u = "https://github.com/geocompx/geocompr/archive/refs/heads/main.zip"
f = basename(u)
download.file(u, f)        # download the file
unzip(f)                   # unzip it
file.rename(f, "geocompr") # rename the directory
rstudioapi::openProject("geococompr") # or open the folder in vscode / other IDE
```

## Reproducing the book in R/RStudio/VS Code

To ease reproducibility, we created the `geocompkg` package. Install it
with the following commands:

``` r
install.packages("remotes")
# To reproduce the first Part (chapters 1 to 8):
install.packages("geocompkg", repos = c("https://geocompr.r-universe.dev", "https://cloud.r-project.org"), dependencies = TRUE, force = TRUE)
```

Installing `geocompkg` will also install core packages required for
reproducing **Part I of the book** (chapters 1 to 8). Note: you may also
need to install [system
dependencies](https://github.com/r-spatial/sf#installing) if youre
running Linux (recommended) or Mac operating systems. You also need to
have the [**remotes**](https://github.com/r-lib/remotes/) package
installed:

To reproduce book **in its entirety**, run the following command (which
installs additional Suggests packages, this may take some time to
run!):

``` r
# Install packages to fully reproduce book (may take several minutes):
options(repos = c(
  geocompx = "https://geocompx.r-universe.dev",
  cran = "https://cloud.r-project.org/"
))
# From geocompx.r-universe.dev (recommended):
install.packages("geocompkg", dependencies = TRUE)

# Alternatively from GitHub:
remotes::install_github("geocompx/geocompkg", dependencies = TRUE)
```

You need a recent version of the GDAL, GEOS, PROJ and udunits libraries
installed for this to work on Mac and Linux. See the **sf** packages
[README](https://github.com/r-spatial/sf) for information on that. After
the dependencies have been installed you should be able to build and
view a local version the book with:

``` r
# Change this depending on where you have the book code stored:
rstudioapi::openProject("~/Downloads/geocompr")
 # or code /location/of/geocompr in the system terminal
 # or cd /location/of/geocompr then R in the system terminal, then:
bookdown::render_book("index.Rmd") # to build the book
browseURL("_book/index.html")      # to view it
# Or, to serve a live preview the book and observe impact of changes:
bookdown::serve_book(".")
```





## Geocompr in a devcontainer

A great feature of VS Code is
[devcontainers](https://code.visualstudio.com/docs/remote/containers),
which allow you to develop in an isolated Docker container. If you have
VS Code and the necessary dependencies installed on your computer, you
can build Geocomputation with R in a devcontainer as shown below (see
[\#873](https://github.com/geocompx/geocompr/issues/873) for details):

![](https://user-images.githubusercontent.com/1825120/193398022-bbcfbfda-5d57-4c57-8db3-ed1fdb4a07be.png)

## Geocompr in Binder

For many people the quickest way to get started with Geocomputation with
R is in your web browser via Binder. To see an interactive RStudio
Server instance click on the following button, which will open
[mybinder.org](https://mybinder.org/v2/gh/geocompx/geocompr/main?urlpath=rstudio)
with an R installation that has all the dependencies needed to reproduce
the book:

[![Launch Rstudio
Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/geocompx/geocompr/main?urlpath=rstudio)

You can also have a play with the repository in RStudio Cloud by
clicking on this link (requires log-in):

[![Launch Rstudio
Cloud](images/cloud.png)](https://rstudio.cloud/project/1642300)

## Geocomputation with R in a Docker container

See the [geocompx/docker](https://github.com/geocompx/docker) repository
for details.

## Reproducing this README

To reduce the books 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:

``` r
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 weve
removed from the main book build to reduce package dependencies and the
books build time:

``` r
source("code/01-cranlogs.R")
source("code/sf-revdep.R")
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](https://github.com/geocompx/geocompr/blob/main/README.Rmd) use
the following command:

``` r
rmarkdown::render("README.Rmd", output_format = "github_document", output_file = "README.md")
```





## Citations

The main packages used in this book are cited from `packages.bib`. Other
citations are stored online using Zotero.

If you would like to add to the references, please use Zotero, join the
[open group](https://www.zotero.org/groups/418217/energy-and-transport)
add your citation to the open [geocompr
library](https://www.zotero.org/groups/418217/energy-and-transport/items/collectionKey/9K6FRP6N).

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](https://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

![](images/zotero-settings.png)

Zotero settings: these are useful if you want to add references.

When you export the citations as a .bib file from Zotero, use the
`Better BibTex` (not `BibLaTeX`) format.

We use Zotero because it is a powerful open source reference manager
that integrates well with citation tools in VS Code and RStudio.

Owner

GitHub Events