R: trim_osmdata

trim_osmdata {osmdata} | R Documentation

## trim_osmdata

### Description

Trim an osmdata object to within a bounding polygon

### Usage

    trim_osmdata(dat, bb_poly, exclude = TRUE)

### Arguments

`dat` | An osmdata object returned from osmdata_sf or osmdata_sp.
`bb_poly` | A matrix representing a bounding polygon obtained with `getbb (..., format_out = "polygon")` (and possibly selected from resultant list where multiple polygons are returned).
`exclude` | If TRUE, objects are trimmed exclusively, only retaining those strictly within the bounding polygon; otherwise all objects which partly extend within the bounding polygon are retained.

### Value

A trimmed version of `dat`, reduced only to those components lying within the bounding polygon.

### Note

It will generally be necessary to pre-load the sf package for this function to work correctly.

### Examples

    ## Not run:
    dat <- opq ("colchester uk") %>%
                add_osm_feature (key="highway") %>%
                osmdata_sf (quiet = FALSE)
    bb <- getbb ("colchester uk", format_out = "polygon")
    library (sf) # required for this function to work
    dat_tr <- trim_osmdata (dat, bb)
    bb <- getbb ("colchester uk", format_out = "sf_polygon")
    class (bb) # sf data.frame
    dat_tr <- trim_osmdata (dat, bb)
    bb <- as (bb, "Spatial")
    class (bb) # SpatialPolygonsDataFrame
    dat_tr <- trim_osmdata (dat, bb)

    ## End(Not run)

[Package osmdata version 0.1.5 Index]