diff --git a/README.Rmd b/README.Rmd
index cffad54f3..a01976c75 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -4,7 +4,6 @@ editor_options:
chunk_output_type: console
---
-
```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
@@ -42,8 +41,8 @@ knitr::knit_hooks$set(output = function(x, options) {
[](https://github.com/r-tmap/tmap/actions/workflows/R-CMD-check.yaml)
[](https://app.codecov.io/gh/r-tmap/tmap?branch=master)
[](https://cran.r-project.org/package=tmap)
-[](https://cran.r-project.org/web/checks/check_results_tmap.html)
-[](https://www.r-pkg.org/pkg/tmap)
+[](https://cran.r-project.org/web/checks/check_results_tmap.html)
+[](https://www.r-pkg.org:443/pkg/tmap)
[](https://www.gnu.org/licenses/gpl-3.0.html)
[](https://r-tmap.r-universe.dev/tmap)
@@ -52,30 +51,23 @@ knitr::knit_hooks$set(output = function(x, options) {
## Installation
-Installation of **tmap** is straightforward:
-
-```{r eval=FALSE}
-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).
-
-### Development version
-
-The development version can be installed from the GitHub repository using
-`remotes` or `pak` packages or from the [R-universe repository](https://r-tmap.r-universe.dev/tmap).
+Installation of **tmap** (version 4) is straightforward:
```{r eval=FALSE}
# install.packages("remotes")
remotes::install_github("r-tmap/tmap")
+# On Linux, with pak
# install.packages("pak")
pak::pak("r-tmap/tmap")
-# Or from R-universe
+# Or from r-universe
install.packages("tmap", repos = c("https://r-tmap.r-universe.dev", "https://cloud.r-project.org"))
```
+The old version of **tmap** (version 3) is available on [](https://cran.r-project.org/package=tmap), but we recommend to use version 4, which will be on CRAN soon.
+
+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.
@@ -86,14 +78,14 @@ See https://geocompx.org/post/2020/installing-r-spatial-packages-linux/. Please
**macOS**
See https://www.kyngchaos.com/. Please address installation issues in this [issue](https://github.com/r-tmap/tmap/issues/149).
-# Getting started
+## Getting started
```{r echo=FALSE, message=FALSE}
library(tmap)
```
Plot a World map of the happy planet index (HPI) per country.
-The object `World` is an example spatial data frame (`sf`) object that is contained in **tmap**:
+The object `World` is an example spatial data (`sf`) object that is contained in **tmap**:
```{r fig.height=3.5}
tm_shape(World) +
@@ -113,10 +105,15 @@ tm_shape(World, crs = "+proj=robin") +
)
```
-# Book chapter about tmap
+## Additional Resources for Learning **tmap**
+
+For more in-depth learning on the **tmap** package, refer to the following resources:
-The book [Geocomputation with R](https://r.geocompx.org/) provides a chapter on [Making maps with R](https://r.geocompx.org/adv-map), including a section on **tmap**.
+- **Book Chapter:** [Geocomputation with R](https://r.geocompx.org/) includes a chapter on [Making Maps with R](https://r.geocompx.org/adv-map), which covers **tmap**.
+- **Official Vignettes:** A collection of vignettes at [r-tmap.github.io](https://r-tmap.github.io/tmap/articles/) covers both basic and advanced topics with examples.
+- **Work-in-Progress Book:** *Elegant and Informative Maps with tmap* is an upcoming book available at [tmap.geocompx.org](https://tmap.geocompx.org/).
+These resources provide a solid foundation for working with **tmap** in R.
[3]: https://cran.r-project.org/package=ggplot2
[4]: https://vita.had.co.nz/papers/layered-grammar.pdf
diff --git a/README.md b/README.md
index 8a3d7840c..cf60f361a 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,8 @@
coverage](https://codecov.io/gh/r-tmap/tmap/branch/master/graph/badge.svg)](https://app.codecov.io/gh/r-tmap/tmap?branch=master)
[](https://cran.r-project.org/package=tmap)
[](https://cran.r-project.org/web/checks/check_results_tmap.html)
-[](https://www.r-pkg.org/pkg/tmap)
+checks](https://cranchecks.info/badges/worst/tmap)](https://cran.r-project.org/web/checks/check_results_tmap.html)
+[](https://www.r-pkg.org:443/pkg/tmap)
[](https://www.gnu.org/licenses/gpl-3.0.html)
[](https://r-tmap.r-universe.dev/tmap)
@@ -23,33 +23,28 @@ R-library for drawing charts.
## Installation
-Installation of **tmap** is straightforward:
-
-``` r
-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).
-
-### Development version
-
-The development version can be installed from the GitHub repository
-using `remotes` or `pak` packages or from the [R-universe
-repository](https://r-tmap.r-universe.dev/tmap).
+Installation of **tmap** (version 4) is straightforward:
``` r
# install.packages("remotes")
remotes::install_github("r-tmap/tmap")
+# On Linux, with pak
# install.packages("pak")
pak::pak("r-tmap/tmap")
-# Or from R-universe
+# Or from r-universe
install.packages("tmap", repos = c("https://r-tmap.r-universe.dev", "https://cloud.r-project.org"))
```
+The old version of **tmap** (version 3) is available on
+[](https://cran.r-project.org/package=tmap),
+but we recommend to use version 4, which will be on CRAN soon.
+
+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
@@ -60,11 +55,11 @@ Please address installation issues in this
**macOS** See . Please address installation
issues in this [issue](https://github.com/r-tmap/tmap/issues/149).
-# Getting started
+## Getting started
Plot a World map of the happy planet index (HPI) per country. The object
-`World` is an example spatial data frame (`sf`) object that is contained
-in **tmap**:
+`World` is an example spatial data (`sf`) object that is contained in
+**tmap**:
``` r
tm_shape(World) +
@@ -73,7 +68,7 @@ tm_shape(World) +
#> This message is displayed once per session.
```
-
+
This map can be enhanced in several ways. For instance:
@@ -87,10 +82,22 @@ tm_shape(World, crs = "+proj=robin") +
)
```
-
+
+
+## Additional Resources for Learning **tmap**
+
+For more in-depth learning on the **tmap** package, refer to the
+following resources:
-# Book chapter about tmap
+- **Book Chapter:** [Geocomputation with R](https://r.geocompx.org/)
+ includes a chapter on [Making Maps with
+ R](https://r.geocompx.org/adv-map), which covers **tmap**.
+- **Official Vignettes:** A collection of vignettes at
+ [r-tmap.github.io](https://r-tmap.github.io/tmap/articles/) covers
+ both basic and advanced topics with examples.
+- **Work-in-Progress Book:** *Elegant and Informative Maps with tmap* is
+ an upcoming book available at
+ [tmap.geocompx.org](https://tmap.geocompx.org/).
-The book [Geocomputation with R](https://r.geocompx.org/) provides a
-chapter on [Making maps with R](https://r.geocompx.org/adv-map),
-including a section on **tmap**.
+These resources provide a solid foundation for working with **tmap** in
+R.
diff --git a/man/figures/README-unnamed-chunk-3-1.png b/man/figures/README-unnamed-chunk-3-1.png
index b4edb7ebb..9d30bdbf5 100644
Binary files a/man/figures/README-unnamed-chunk-3-1.png and b/man/figures/README-unnamed-chunk-3-1.png differ
diff --git a/man/figures/README-unnamed-chunk-4-1.png b/man/figures/README-unnamed-chunk-4-1.png
index 591390dce..f92160491 100644
Binary files a/man/figures/README-unnamed-chunk-4-1.png and b/man/figures/README-unnamed-chunk-4-1.png differ