highlight.borders: Creates an sf data.frame object (from the sf package)...

View source: R/highlight.borders.R

highlight.bordersR Documentation

Creates an sf data.frame object (from the sf package) identifying a subset of borders between neighbouring areas.

Description

Creates an sf data.frame object (from the sf package) identifying a subset of borders between neighbouring areas, which allows them to be overlayed on a map. An example is given in the vignette accompanying this package.

Usage

highlight.borders(border.locations, sfdata)

Arguments

border.locations

A K by K matrix, where K is the number of areas, containing 3 distinct values: NA for non-neighbouring areas; 0 for borders between neighbouring areas to be highlighted on a map; and 1 for borders between neighbouring areas not to be highlighted on a map.

sfdata

An sf data.frame (from the sf package) object used for plotting the data and creating the original neighbourhood matrix W.

Value

An sf data.frame object from the sf package, which contains the vertices of all the borders to be highlighted on the map. The mapping can be done using the mapview package, see the vignette accompanying this package for an example.

Author(s)

Duncan Lee

Examples

## See the vignette accompanying this package for an example of its use.

CARBayes documentation built on May 29, 2024, 7:44 a.m.