basemap | R Documentation |
These functions (down)load and cache a basemap of a defined extent ext
, map_service
and map_type
and return it as an object of the defined class. Alternatively to defining the following arguments, set_defaults
can be used to define basemap preferences once for the running session.
basemap( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, class = "plot", force = FALSE, ..., verbose = TRUE ) basemap_plot( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_magick( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_png( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_geotif( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_terra( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_raster( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_stars( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_ggplot( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_gglayer( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE ) basemap_mapview( ext = NULL, map_service = NULL, map_type = NULL, map_res = NULL, map_token = NULL, map_dir = NULL, force = NULL, ..., verbose = TRUE )
ext |
extent to be covered by the basemap as any spatial class supported by |
map_service |
character, a map service, either |
map_type |
character, a map type, e.g. |
map_res |
numeric, resolution of base map in range from 0 to 1. |
map_token |
character, authentification token for services that require registration, which are |
map_dir |
character, cache directory where downloaded basemap tiles will be stored. By default, a temporary directory is used, which is destroyed when the session is terminated. |
class |
character, output class, either either |
force |
logical, whether to force download over cached files or not. Default is |
... |
additional arguments, including
|
verbose |
logical, if |
A basemap of the defined class in Web/Pseudo Mercator Projection (EPSG: 3857)
See get_maptypes for available map services and their sources.
The use of the map services "osm_thunderforest"
and "mapbox"
require registration to obtain an API token/key which can be supplied to map_token
. Register at https://www.thunderforest.com/ and/or https://www.mapbox.com/ to get a token.
library(basemaps) # example extent data(ext) # view all available maps get_maptypes() # set defaults for the basemap set_defaults(map_service = "osm", map_type = "terrain_bg") # for osm_thunderforest and mapbox maps, you need a API token. # Register for free at thunderforest.com and mapbox.com to get a token ## Not run: # load and return basemap map as raster (default) map <- basemap(ext) # or explicitely as different classes such as: basemap_magick(ext) basemap_raster() basemap_stars() # or as files: basemap_geotif() basemap_png() # or as plots: basemap_plot(ext) basemap_mapview() # including ggplot2: basemap_ggplot(ext) # or as ggplot2 layer: library(ggplot2) ggplot() + basemap_gglayer(ext) + scale_fill_identity() + coord_sf() # or, when combined with an sf vector object, # make sure to use Web/Pseudo Mercator (EPSG 3857), as this is # the CRS in which all basemaps are returned (see "Value"): library(sf) ext <- st_transform(ext, crs = st_crs(3857)) ggplot() + basemap_gglayer(ext) + geom_sf(data = ext, color = "red", fill = "transparent") + coord_sf() + scale_fill_identity() ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.