R: Control checking of spatial object IDs

set.spChkOption {spdep} | R Documentation

## Control checking of spatial object IDs

### Description

Provides support for checking the mutual integrity of spatial neighbour weights and spatial data; similar mechanisms are used for passing global verbose and zero.policy options, and for providing access to a running cluster for embarrassingly parallel tasks.

### Usage

    set.spChkOption(check)
    get.spChkOption()
    chkIDs(x, listw)
    spNamedVec(var, data)
    set.VerboseOption(check)
    get.VerboseOption()
    set.ZeroPolicyOption(check)
    get.ZeroPolicyOption()
    set.listw_is_CsparseMatrix_Option(check)
    get.listw_is_CsparseMatrix_Option()

### Arguments

`check` | a logical value, TRUE or FALSE
`x` | a vector the same length, or a two-dimensional array, or data frame with the same number of rows as the neighbours list in listw
`listw` | a `listw` object or `nb` object inheriting from "nb"
`var` | a character string or integer value for the column to be selected
`data` | a two-dimensional array or data frame containing var

### Details

Analysis functions will have an spChk argument by default set to NULL, and will call `get.spChkOption()` to get the global spatial option for whether to check or not — this is initialised to FALSE, and consequently should not break anything. It can be changed to TRUE using `set.spChkOption(TRUE)`, or the spChk argument can be assigned in analysis functions. `spNamedVec()` is provided to ensure that rownames are passed on to single columns taken from two-dimensional arrays and data frames.

### Value

`set.spChkOption()` returns the old logical value, `get.spChkOption()` returns the current logical value, and `chkIDs()` returns a logical value for the test lack of difference. `spNamedVec()` returns the selected column with the names set to the row names of the object from which it has been extracted.

### Note

The motivation for this mechanism is provided by the observation that spatial objects on a map and their attribute data values need to be linked uniquely, to avoid spurious results. The reordering between the legacy Columbus data set used the earlier publications and that available for download from the Spacestat website is just one example of a common problem.

### Author(s)

Roger Bivand Roger.Bivand@nhh.no

### Examples

    data(oldcol)
    rownames(COL.OLD)
    data(columbus, package="spData")
    rownames(columbus)
    get.spChkOption()
    oldChk <- set.spChkOption(TRUE)
    get.spChkOption()
    chkIDs(COL.OLD, nb2listw(COL.nb))
    chkIDs(columbus, nb2listw(col.gal.nb))
    chkIDs(columbus, nb2listw(COL.nb))
    tmp <- try(moran.test(spNamedVec("CRIME", COL.OLD), nb2listw(COL.nb)))
    print(tmp)
    tmp <- try(moran.test(spNamedVec("CRIME", columbus), nb2listw(col.gal.nb)))
    print(tmp)
    tmp <- try(moran.test(spNamedVec("CRIME", columbus), nb2listw(COL.nb)))
    print(tmp)
    set.spChkOption(FALSE)
    get.spChkOption()
    moran.test(spNamedVec("CRIME", columbus), nb2listw(COL.nb))
    tmp <- try(moran.test(spNamedVec("CRIME", columbus), nb2listw(COL.nb),
     spChk=TRUE), silent=TRUE)
    print(tmp)
    set.spChkOption(oldChk)
    get.spChkOption()

[Package spdep version 1.2-2 Index]