Skip to content

r-tmap/tmap

Repository files navigation

tmap: thematic maps in R

R-CMD-check Codecov test coverage CRAN CRAN checks Downloads License r-universe

tmap is an actively maintained open-source R-library for drawing thematic maps. The API is based on A Layered Grammar of Graphics and resembles the syntax of ggplot2, a popular R-library for drawing charts.

Classic World Map Bubble Map Bubble Map World facets US Choropleth US Choropleth London Crimes London Crimes London Crimes London Crimes

See below the source code for these images.

Installation

tmap is available on CRAN. Installation is straightforward:

install.packages("tmap")

For Linux and macOS users who are new to working with spatial data in R, this may fail since additional (non-R) libraries are required (which are automatically installed for Windows users).

Windows No additional installation required.

Linux (Ubuntu) See https://geocompx.org/post/2020/installing-r-spatial-packages-linux/. Please address installation issues in this issue.

macOS See https://www.kyngchaos.com/. Please address installation issues in this issue.

Development

The latest development version can be installed using remotes. In order to use the development version of tmap, it is recommended to use the development version of tmaptools as well:

# install.packages("remotes")
install_github("r-tmap/tmaptools")
install_github("r-tmap/tmap")

# On Linux, with pak
# install.packages("pak")
pak::pak("r-tmap/tmap")

# Or from r-universe
install.packages("tmap", repos = c("https://r-tmap.r-universe.dev", "https://cloud.r-project.org"))

See NEWS for the latest features and improvements and the issue list for discussions of enhancements and bugs.

Do you want to help with the development of the package? Please let us know! Any feedback, requests, tips, or bug reports are welcome!

Usage

library(tmap)

Reference

Tennekes, M., 2018, tmap: Thematic Maps in R, Journal of Statistical Software, 84(6), 1-39

This paper has been written for tmap 1.11-2. See the reproducible code using tmap 2.x.

Vignettes

tmap v3: get started!

tmap: what is changed in recent versions?

Tutorials

tmap in RMarkdown

Presentations

Other resources

Getting help

There are two main places to get help with tmap:

  1. stackoverflow is a great source of answers to common tmap questions. It is also a great place to get help, once you have created a reproducible example that illustrates your problem. Please tag your questions with tmap.
  2. If you have a request or if think your problem is caused by a bug, please open an issue, preferably with a reproducible example.