From 9e805f244c088168273e363fe9f4bb16be5e8d7f Mon Sep 17 00:00:00 2001 From: Jakub Nowosad Date: Fri, 4 Jul 2025 11:08:01 +0200 Subject: [PATCH] updates bbox docs --- R/tm_crs.R | 2 +- man/tm_crs.Rd | 2 +- man/tm_shape.Rd | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/R/tm_crs.R b/R/tm_crs.R index ed14ccaf..e1f23ec7 100644 --- a/R/tm_crs.R +++ b/R/tm_crs.R @@ -4,7 +4,7 @@ #' #' @param crs Map projection (CRS). Can be set to an `crs` object (see [sf::st_crs()]), a proj4string, an EPSG number, the value `"auto"` (automatic crs recommendation), or one the the following generic projections: `c("laea", "aeqd", "utm", "pconic", "eqdc", "stere")`. See details. #' @param property Which property should the projection have? One of: `"global"`, `"area"` (equal-area), `"distance"` (equidistant), `"shape"` (conformal). Only applicable if `crs = "auto"`. See details. -#' @param bbox bounding box. Three options: a [sf::st_bbox()] object, an Open Street Map query (passed on to [tmaptools::geocode_OSM()]), or `"FULL"`, which means the whole earth. +#' @param bbox bounding box. Three options: a [sf::st_bbox()] object, an Open Street Map query (passed on to [tmaptools::geocode_OSM()]), or `"FULL"`, which means the whole earth , which means the whole earth (this also guarantees that transformations to another CRS keep the whole earth, unlike \code{\link[sf:st_bbox]{sf::st_bbox()}}). #' @note Plans are to migrate the functionality regarding generic crs and automatic crs recommendation to a separate package. #' @inherit tm_shape details #' @example ./examples/tm_crs.R diff --git a/man/tm_crs.Rd b/man/tm_crs.Rd index 7ed7eb82..7b33fe11 100644 --- a/man/tm_crs.Rd +++ b/man/tm_crs.Rd @@ -11,7 +11,7 @@ tm_crs(crs = NA, property = NA, bbox = NULL) \item{property}{Which property should the projection have? One of: \code{"global"}, \code{"area"} (equal-area), \code{"distance"} (equidistant), \code{"shape"} (conformal). Only applicable if \code{crs = "auto"}. See details.} -\item{bbox}{bounding box. Three options: a \code{\link[sf:st_bbox]{sf::st_bbox()}} object, an Open Street Map query (passed on to \code{\link[tmaptools:geocode_OSM]{tmaptools::geocode_OSM()}}), or \code{"FULL"}, which means the whole earth.} +\item{bbox}{bounding box. Three options: a \code{\link[sf:st_bbox]{sf::st_bbox()}} object, an Open Street Map query (passed on to \code{\link[tmaptools:geocode_OSM]{tmaptools::geocode_OSM()}}), or \code{"FULL"}, which means the whole earth , which means the whole earth (this also guarantees that transformations to another CRS keep the whole earth, unlike \code{\link[sf:st_bbox]{sf::st_bbox()}}).} } \description{ This function sets the map projection. It can also be set via \code{\link[=tm_shape]{tm_shape()}}, but \code{tm_crs} is generally recommended for most cases. It can also be determined automatically (see details); however, this is still work-in-progress. diff --git a/man/tm_shape.Rd b/man/tm_shape.Rd index 9ec5459c..df1a3e20 100644 --- a/man/tm_shape.Rd +++ b/man/tm_shape.Rd @@ -18,7 +18,7 @@ tm_shape( \arguments{ \item{shp}{Spatial object} -\item{bbox}{Bounding box of the map (only used if \code{shp} is the main shape (see \code{is.main}). Three options: a \code{\link[sf:st_bbox]{sf::st_bbox()}} object, an Open Street Map query (passed on to \code{\link[tmaptools:geocode_OSM]{tmaptools::geocode_OSM()}}), or \code{"FULL"}, which means the whole earth.} +\item{bbox}{Bounding box of the map (only used if \code{shp} is the main shape (see \code{is.main}). Three options: a \code{\link[sf:st_bbox]{sf::st_bbox()}} object, an Open Street Map query (passed on to \code{\link[tmaptools:geocode_OSM]{tmaptools::geocode_OSM()}}), or \code{"FULL"}, which means the whole earth (this also guarantees that transformations to another CRS keep the whole earth, unlike \code{\link[sf:st_bbox]{sf::st_bbox()}}).} \item{crs}{Map projection (CRS). Can be set to an \code{crs} object (see \code{\link[sf:st_crs]{sf::st_crs()}}), a proj4string, an EPSG number, the value \code{"auto"} (automatic crs recommendation), or one the the following generic projections: \code{c("laea", "aeqd", "utm", "pconic", "eqdc", "stere")}. See details.}