Skip to content

Commit 2e3a5f3

Browse files
committed
updated frames_spatial manual
1 parent 270605f commit 2e3a5f3

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

R/frames_spatial.R

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,17 @@
4646
#' @param verbose logical, if \code{TRUE}, messages and progress information are displayed on the console (default).
4747
#'
4848
#' @details If argument \code{path_colours} is not defined (set to \code{NA}), path colours can be defined by adding a character column named \code{colour} to \code{m}, containing a colour code or name per row (e.g. \code{"red"}. This way, for example, column \code{colour} for all rows belonging to individual A can be set to \code{"green"}, while column \code{colour} for all rows belonging to individual B can be set to \code{"red"}.
49-
#' Colours could also be arranged to change through time or by behavioral segments, geographic locations, age, environmental or health parameters etc. If a column name \code{colour} in \code{m} is missing, colours will be selected automatically. Call \code{colours()} to see all available colours in R.
49+
#' Colours could also be arranged to change through time or by behavioural segments, geographic locations, age, environmental or health parameters etc. If a column name \code{colour} in \code{m} is missing, colours will be selected using \code{path_colours} or automatically. Call \code{colours()} to see all available colours in R.
5050
#'
51-
#' Basemap colour scales can be changed/added using \code{\link{add_colourscale}} or by using \code{ggplot2} commands (see \code{examples}). For continous scales, use \code{r_type = "gradient"}. For discrete scales, use \code{r_type = "discrete"}.
51+
#' Basemap colour scales can be changed/added using \code{\link{add_colourscale}} or by using \code{ggplot2} commands (see \code{examples}). For continuous scales, use \code{r_type = "gradient"}. For discrete scales, use \code{r_type = "discrete"}.
5252
#'
53-
#' If argument \code{equidistant} is set, the map extent is calculated (thus enlarged into one axis direction) to represent equal surface distances on the x and y axis.
53+
#' If argument \code{equidistant} is set, the map extent is calculated (thus enlarged into one axis direction) to represent equal distances on the x and y axis.
5454
#'
5555
#' @note
5656
#'
57-
#' The use of the map services \code{"osm_thunderforest"} and \code{"mapbox"} require registration to obtain an API token/key which can be supplied to \code{map_token}. Register at \url{https://www.thunderforest.com/} and/or \url{https://www.mapbox.com/} to get a token.
57+
#' The use of some map services, e.g. \code{"osm_stadia"}, \code{"osm_thunderforest"} or \code{"mapbox"}, require registration to obtain an API token/key which can be supplied to \code{map_token}. See \code{\link[basemaps]{get_maptypes}} for details.
5858
#'
59-
#' The projection of \code{m} is treated as target projection. Default basemaps accessed through a map service will be reprojected into the projection of \code{m}. Thus, depending on the projection of \code{m}, it may happen that map labels are distorted. To get undistorted map labels, reproject \code{m} to the web mercator projection (the default projection for basemaps): \code{spTransform(m, crs("+init=epsg:3857"))}
59+
#' The Coordinate Reference System defined by argument \code{crs} is treated as target projection. Both \code{m}, basemaps accessed through a map service, or custom imagery provided through argument \code{r} will be reprojected into \code{crs}. The default CRS is Web Mercator (EPSG 3857), which guarantees undistorted map labels in web basemap imagery.
6060
#'
6161
#' @return A frames object of class \code{moveVis}.
6262
#'

man/frames_spatial.Rd

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)