这是indexloc提供的服务，不要输入任何密码
Skip to content

Adds resources urls to README (closes #803) #1049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 25, 2025
Merged

Adds resources urls to README (closes #803) #1049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 17 additions & 20 deletions README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ editor_options:
chunk_output_type: console
---


```{r setup, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
Expand Down Expand Up @@ -42,8 +41,8 @@ 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://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/pkg/tmap)
[![CRAN checks](https://cranchecks.info/badges/worst/tmap)](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)
<!-- badges: end -->
Expand All @@ -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 [![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.
Copy link
Contributor

@kadyb kadyb Feb 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Version 4.0 is already on CRAN, isn't it? Older versions are now available in the CRAN archive.

Maybe this will be better: "The old version of tmap (version 3) is available in the CRAN archive. We recommend moving to the new version 4.0, which is available on CRAN."


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.
Expand All @@ -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) +
Expand All @@ -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
61 changes: 34 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
[![CRAN](https://www.r-pkg.org/badges/version/tmap)](https://cran.r-project.org/package=tmap)
[![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/pkg/tmap)
checks](https://cranchecks.info/badges/worst/tmap)](https://cran.r-project.org/web/checks/check_results_tmap.html)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link to CRAN checks was correct (https://badges.cranchecks.info/worst/tmap.svg). After this change it doesn't work.

[![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)
<!-- badges: end -->
Expand All @@ -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
[![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** No additional installation required.

**Linux (Ubuntu)** See
Expand All @@ -60,11 +55,11 @@ Please address installation issues in this
**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

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) +
Expand All @@ -73,7 +68,7 @@ tm_shape(World) +
#> This message is displayed once per session.
```

<img src="man/figures/README-unnamed-chunk-4-1.png" width="100%" />
<img src="man/figures/README-unnamed-chunk-3-1.png" width="100%" />

This map can be enhanced in several ways. For instance:

Expand All @@ -87,10 +82,22 @@ tm_shape(World, crs = "+proj=robin") +
)
```

<img src="man/figures/README-unnamed-chunk-5-1.png" width="100%" />
<img src="man/figures/README-unnamed-chunk-4-1.png" width="100%" />

## 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.
Binary file modified man/figures/README-unnamed-chunk-3-1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-unnamed-chunk-4-1.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading