diff --git a/R/pkg.R b/R/pkg.R index 59c25b73..4e5d88b7 100644 --- a/R/pkg.R +++ b/R/pkg.R @@ -2,7 +2,7 @@ #' #' Thematic maps are geographical maps in which spatial data distributions are visualized. This package offers a flexible, layer-based, and easy to use approach to create thematic maps, such as choropleths and bubble maps. It is based on the grammar of graphics, and resembles the syntax of ggplot2. #' -#' This page provides a brief overview of all package functions. See [`vignette("tmap-getstarted")`](../doc/tmap-getstarted.html) for a short introduction with examples. +#' This page provides a brief overview of all package functions. See `vignette("tmap_sneek_peek")` for a short introduction with examples. #' #' @section Quick plotting method: #' \tabular{ll}{ @@ -113,6 +113,6 @@ #' @concept statistical maps #' @concept choropleth #' @concept bubble map -#' @seealso [`vignette("tmap-getstarted")`](../doc/tmap-getstarted.html) +#' @seealso `vignette("tmap_sneek_peek")` #' @references Tennekes, M., 2018, {tmap}: Thematic Maps in {R}, Journal of Statistical Software, 84(6), 1-39, \doi{10.18637/jss.v084.i06} "_PACKAGE" diff --git a/R/qtm.R b/R/qtm.R index f7e00f7d..5e05019e 100644 --- a/R/qtm.R +++ b/R/qtm.R @@ -28,7 +28,7 @@ #' @param ... arguments passed on to the `tm_*` functions. The prefix of these arguments should be with the layer function name without `"tm_"` and a period. For instance, the palette for polygon fill color is called `fill.palette`. The following prefixes are supported: `shape.`, `fill.`, `borders.`, `polygons.`, `symbols.`, `dots.`, `lines.`, `raster.`, `text.`, `layout.`, `grid.`, `facets.`, and `view.`. Arguments that have a unique name, i.e. that does not exist in any other layer function, e.g. `convert2density`, can also be called without prefix. #' @return [tmap-element()] #' @example ./examples/qtm.R -#' @seealso [`vignette("tmap-getstarted")`](../doc/tmap-getstarted.html) +#' @seealso `vignette("tmap_sneek_peek")` #' @references Tennekes, M., 2018, {tmap}: Thematic Maps in {R}, Journal of Statistical Software, 84(6), 1-39, \doi{10.18637/jss.v084.i06} #' @export qtm <- function(shp, diff --git a/R/tmap_mode.R b/R/tmap_mode.R index 6265f036..308cf9a6 100644 --- a/R/tmap_mode.R +++ b/R/tmap_mode.R @@ -16,7 +16,7 @@ #' }} #' @return The mode before changing #' @example ./examples/tmap_mode.R -#' @seealso [`vignette("tmap-getstarted")`](../doc/tmap-getstarted.html), [tmap_last()] to show the last map, [tm_view()] for viewing options, and [tmap_leaflet()] for obtaining a leaflet widget, and [tmap_options()] for tmap options. +#' @seealso `vignette("tmap_sneek_peek")`, [tmap_last()] to show the last map, [tm_view()] for viewing options, and [tmap_leaflet()] for obtaining a leaflet widget, and [tmap_options()] for tmap options. #' @references Tennekes, M., 2018, {tmap}: Thematic Maps in {R}, Journal of Statistical Software, 84(6), 1-39, \doi{10.18637/jss.v084.i06} #' @export tmap_mode = function(mode=NULL) { diff --git a/README.md b/README.md index a97f36a7..2f83fc54 100644 --- a/README.md +++ b/README.md @@ -96,7 +96,7 @@ This paper has been written for `tmap` 1.11-2. See the [reproducible code](https Vignettes ----- -[tmap: get started!](https://cran.r-project.org/package=tmap/vignettes/tmap-getstarted.html) +[tmap v3: get started!](https://cran.r-project.org/package=tmap/vignettes/tmap-getstarted.html) [tmap: what is changed in recent versions?](https://cran.r-project.org/package=tmap/vignettes/tmap-changes.html) diff --git a/man/qtm.Rd b/man/qtm.Rd index 11e14a07..464d9212 100644 --- a/man/qtm.Rd +++ b/man/qtm.Rd @@ -127,5 +127,5 @@ qtm("Amsterdam") Tennekes, M., 2018, {tmap}: Thematic Maps in {R}, Journal of Statistical Software, 84(6), 1-39, \doi{10.18637/jss.v084.i06} } \seealso{ -\href{../doc/tmap-getstarted.html}{\code{vignette("tmap-getstarted")}} +\code{vignette("tmap_sneek_peek")} } diff --git a/man/tmap-package.Rd b/man/tmap-package.Rd index 3aa74c65..a4dff4fa 100644 --- a/man/tmap-package.Rd +++ b/man/tmap-package.Rd @@ -9,7 +9,7 @@ Thematic maps are geographical maps in which spatial data distributions are visualized. This package offers a flexible, layer-based, and easy to use approach to create thematic maps, such as choropleths and bubble maps. It is based on the grammar of graphics, and resembles the syntax of ggplot2. } \details{ -This page provides a brief overview of all package functions. See \href{../doc/tmap-getstarted.html}{\code{vignette("tmap-getstarted")}} for a short introduction with examples. +This page provides a brief overview of all package functions. See \code{vignette("tmap_sneek_peek")} for a short introduction with examples. } \section{Quick plotting method}{ @@ -125,7 +125,7 @@ Create icons: Tennekes, M., 2018, {tmap}: Thematic Maps in {R}, Journal of Statistical Software, 84(6), 1-39, \doi{10.18637/jss.v084.i06} } \seealso{ -\href{../doc/tmap-getstarted.html}{\code{vignette("tmap-getstarted")}} +\code{vignette("tmap_sneek_peek")} } \author{ Martijn Tennekes \email{mtennekes@gmail.com} diff --git a/man/tmap_mode.Rd b/man/tmap_mode.Rd index aad85031..dbedef61 100644 --- a/man/tmap_mode.Rd +++ b/man/tmap_mode.Rd @@ -51,5 +51,5 @@ tm_shape(World) + tm_polygons("HPI") Tennekes, M., 2018, {tmap}: Thematic Maps in {R}, Journal of Statistical Software, 84(6), 1-39, \doi{10.18637/jss.v084.i06} } \seealso{ -\href{../doc/tmap-getstarted.html}{\code{vignette("tmap-getstarted")}}, \code{\link[=tmap_last]{tmap_last()}} to show the last map, \code{\link[=tm_view]{tm_view()}} for viewing options, and \code{\link[=tmap_leaflet]{tmap_leaflet()}} for obtaining a leaflet widget, and \code{\link[=tmap_options]{tmap_options()}} for tmap options. +\code{vignette("tmap_sneek_peek")}, \code{\link[=tmap_last]{tmap_last()}} to show the last map, \code{\link[=tm_view]{tm_view()}} for viewing options, and \code{\link[=tmap_leaflet]{tmap_leaflet()}} for obtaining a leaflet widget, and \code{\link[=tmap_options]{tmap_options()}} for tmap options. } diff --git a/vignettes/tmap_vv.Rmd b/vignettes/tmap_vv.Rmd index 281e42ab..de9ff415 100644 --- a/vignettes/tmap_vv.Rmd +++ b/vignettes/tmap_vv.Rmd @@ -31,7 +31,7 @@ data(World, metro, rivers, land) ## Introduction -**tmap** is an R package for spatial data visualization. This vignette describes the alpha version of the major update (version 4), which will be on CRAN in the course of 2022. +**tmap** is an R package for spatial data visualization. This vignette describes the alpha version of the major update (version 4), which will be on CRAN in the course of 2023. #### tmap 4 - tmap 3.x