diff --git a/README.Rmd b/README.Rmd index a01976c75..a35945b9f 100644 --- a/README.Rmd +++ b/README.Rmd @@ -41,7 +41,7 @@ knitr::knit_hooks$set(output = function(x, options) { [![R-CMD-check](https://github.com/r-tmap/tmap/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/r-tmap/tmap/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/r-tmap/tmap/branch/master/graph/badge.svg)](https://app.codecov.io/gh/r-tmap/tmap?branch=master) [![CRAN](https://www.r-pkg.org/badges/version/tmap)](https://cran.r-project.org/package=tmap) -[![CRAN checks](https://cranchecks.info/badges/worst/tmap)](https://cran.r-project.org/web/checks/check_results_tmap.html) +[![CRAN checks](https://badges.cranchecks.info/worst/tmap.svg)](https://cran.r-project.org/web/checks/check_results_tmap.html) [![Downloads](https://cranlogs.r-pkg.org/badges/tmap?color=brightgreen)](https://www.r-pkg.org:443/pkg/tmap) [![License](https://img.shields.io/badge/License-GPL%20v3-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0.html) [![r-universe](https://r-tmap.r-universe.dev/badges/tmap)](https://r-tmap.r-universe.dev/tmap) @@ -53,11 +53,22 @@ knitr::knit_hooks$set(output = function(x, options) { Installation of **tmap** (version 4) is straightforward: +```{r eval=FALSE} +install.packages("tmap") +``` + +The old version of **tmap** (version 3) is available in the [CRAN archive](https://cran.r-project.org/src/contrib/Archive/tmap/), +but we recommend moving to the new version 4. + +### Development version + +The development version can be installed from the GitHub repository using +`remotes` and `pak` packages or from the [R-universe repository](https://r-tmap.r-universe.dev/tmap). + ```{r eval=FALSE} # install.packages("remotes") remotes::install_github("r-tmap/tmap") -# On Linux, with pak # install.packages("pak") pak::pak("r-tmap/tmap") @@ -65,8 +76,6 @@ pak::pak("r-tmap/tmap") 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 [![CRAN](https://www.r-pkg.org/badges/version/tmap)](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** @@ -87,7 +96,7 @@ library(tmap) Plot a World map of the happy planet index (HPI) per country. The object `World` is an example spatial data (`sf`) object that is contained in **tmap**: -```{r fig.height=3.5} +```{r fig.height=3.5, message=FALSE} tm_shape(World) + tm_polygons(fill = "HPI") ``` diff --git a/README.md b/README.md index cf60f361a..b5c16a7ba 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ coverage](https://codecov.io/gh/r-tmap/tmap/branch/master/graph/badge.svg)](https://app.codecov.io/gh/r-tmap/tmap?branch=master) [![CRAN](https://www.r-pkg.org/badges/version/tmap)](https://cran.r-project.org/package=tmap) [![CRAN -checks](https://cranchecks.info/badges/worst/tmap)](https://cran.r-project.org/web/checks/check_results_tmap.html) +checks](https://badges.cranchecks.info/worst/tmap.svg)](https://cran.r-project.org/web/checks/check_results_tmap.html) [![Downloads](https://cranlogs.r-pkg.org/badges/tmap?color=brightgreen)](https://www.r-pkg.org:443/pkg/tmap) [![License](https://img.shields.io/badge/License-GPL%20v3-brightgreen.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0.html) [![r-universe](https://r-tmap.r-universe.dev/badges/tmap)](https://r-tmap.r-universe.dev/tmap) @@ -25,11 +25,24 @@ R-library for drawing charts. Installation of **tmap** (version 4) is straightforward: +``` r +install.packages("tmap") +``` + +The old version of **tmap** (version 3) is available in the [CRAN +archive](https://cran.r-project.org/src/contrib/Archive/tmap/), but we +recommend moving to the new version 4. + +### Development version + +The development version can be installed from the GitHub repository +using `remotes` and `pak` packages or from the [R-universe +repository](https://r-tmap.r-universe.dev/tmap). + ``` r # install.packages("remotes") remotes::install_github("r-tmap/tmap") -# On Linux, with pak # install.packages("pak") pak::pak("r-tmap/tmap") @@ -37,10 +50,6 @@ pak::pak("r-tmap/tmap") 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 -[![CRAN](https://www.r-pkg.org/badges/version/tmap)](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). @@ -64,11 +73,9 @@ Plot a World map of the happy planet index (HPI) per country. The object ``` r tm_shape(World) + tm_polygons(fill = "HPI") -#> [tip] Consider a suitable map projection, e.g. by adding `+ tm_crs("auto")`. -#> This message is displayed once per session. ``` - + This map can be enhanced in several ways. For instance: @@ -82,7 +89,7 @@ tm_shape(World, crs = "+proj=robin") + ) ``` - + ## Additional Resources for Learning **tmap** diff --git a/man/figures/README-unnamed-chunk-4-1.png b/man/figures/README-unnamed-chunk-4-1.png index f92160491..66fbe9e9a 100644 Binary files a/man/figures/README-unnamed-chunk-4-1.png and b/man/figures/README-unnamed-chunk-4-1.png differ diff --git a/man/figures/README-unnamed-chunk-5-1.png b/man/figures/README-unnamed-chunk-5-1.png index 206f1ed8c..e777385b3 100644 Binary files a/man/figures/README-unnamed-chunk-5-1.png and b/man/figures/README-unnamed-chunk-5-1.png differ