R: Compute a Neighborhood Matrix from Spatial Polygons

neighbormatrix {bamlss} | R Documentation

## Compute a Neighborhood Matrix from Spatial Polygons

### Description

The function takes a `SpatialPolygonsDataFrame` and computes the neighbor penalty matrix that can be used to fit a Markov random field, e.g., using the smooth constructor `smooth.construct.mrf.smooth.spec`.

### Usage

    ## Compute the neighborhood matrix.
    neighbormatrix(x, type = c("boundary", "dist", "delaunay", "knear"),
      k = 1, id = NULL, nb = FALSE, names = NULL, ...)

    ## Plot neighborhood structure.
    plotneighbors(x, add = FALSE, ...)

### Arguments

`x` | An object of class `"SpatialPolygons"` or `"SpatialPolygonsDataFrame"`.
`type` | Which type of neighborhood structure should be used, `"boundary"` uses `poly2nb`, `"dist"` uses function `dnearneigh`, `"delaunay"` uses function `tri2nb` and option `"knear"` applies function `knn2nb`.
`k` | For `type = "knear"`, specifies number of nearest neighbors.
`id` | An identifier variable for which the penalty matrix should be computed.
`nb` | Should only the neighborhood object be returned.
`names` | Specifies the column where the regions names are provided in the data slot in the `"SpatialPolygonsDataFrame"`
`add` | Should the neighborhood structure be added to an existing plot?
`...` | Arguments to be passed to function `poly2nb`, `dnearneigh`, `tri2nb` or `knn2nb`.

### See Also

`smooth.construct.mrf.smooth.spec`, `dnearneigh`, `tri2nb`, `knn2nb`.

### Examples

    ## Not run: data("LondonFire")

    ## Compute polygon boundary based
    ## neighborhood matrix.
    nm <- neighbormatrix(LondonBoroughs)
    print(nm)

    ## Plot neighborhood structures.
    plotneighbors(LondonBoroughs)
    plotneighbors(LondonBoroughs, type = "delaunay")
    plotneighbors(LondonBoroughs, type = "dist", d1 = 0, d2 = 0.15)

    ## End(Not run)

[Package bamlss version 1.1-7 Index]