tmaptools: crop_shape – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

crop_shape

Crop shape object

Description

Crop a shape object (from class sf, stars, sp, or raster). A shape file x is cropped, either by the bounding box of another shape y, or by y itself if it is a SpatialPolygons object and polygon = TRUE.

Usage

crop_shape(x, y, polygon = FALSE, ...)

Arguments

`x`	shape object, i.e. an object from class `sf`, `stars`, `sp`, or `raster`.
`y`	bounding box, an `st_bbox`, `extent` (`raster` package), or a shape object from which the bounding box is extracted (unless `polygon` is `TRUE` and `x` is an `sf` object).
`polygon`	should `x` be cropped by the polygon defined by `y`? If `FALSE` (default), `x` is cropped by the bounding box of `x`. Polygon cropping only works when `x` is a spatial object and `y` is a `SpatialPolygons` object.
`...`	not used anymore

Details

This function is similar to crop from the raster package. The main difference is that crop_shape also allows to crop using a polygon instead of a rectangle.

Value

cropped shape, in the same class as x

Examples

if (require(tmap) && packageVersion("tmap") >= "2.0") {
    data(World, NLD_muni, land, metro)

    #land_NLD <- crop_shape(land, NLD_muni)

    #qtm(land_NLD, raster="trees", style="natural")

    metro_Europe <- crop_shape(metro, World[World$continent == "Europe", ], polygon = TRUE)

    qtm(World) +
    tm_shape(metro_Europe) +
    	tm_bubbles("pop2010", col="red", title.size="European cities") +
    	tm_legend(frame=TRUE)
}

tmaptools

Thematic Map Tools

v3.1-1

GPL-3

Authors

Martijn Tennekes [aut, cre]

Initial release

2021-01-19