Summary Method

DESCRIPTION:

Returns a summary list for objects of class spatial.neighbor.

USAGE:

summary.spatial.neighbor(object) 

REQUIRED ARGUMENTS:

object
an object that inherits from class "spatial.neighbor".

VALUE:

an object of class "summary.spatial.neighbor" which is a list of lists, one list for each unique value of matrix in object. The sublists each contain the components that summarize the particular spatial neighbor matrix:
nregion
an integer indicating the number of regions object covers. This is the same as attr(object,"nregion")
symmetric
a logical value, if TRUE the object is assumed to be symmetric. This is the same as attr(object,"symmetric")
minConnected
a named vector of the least connected regions. The names are the row indices that have the smallest number of connections for the i-th matrix in object. The values (all the same) are the minimum number of neighbors.
maxConnected
a named vector of the most connected regions. The names are the row indices that have the largest number of connections for the i-th matrix in object. The values (all the same) are the maximum number of neighbors.
aveNumLinks
a single value giving the mean number of neighbors each region has.
aveWeight
a single value giving the mean weight value for this matrix.
rowMissing
a vector of indices that are not present in object$row.id for the i-th matrix. This will be printed as "none" by the print method if there are no missing row indices and it is not printed at all if object is a symmetric spatial neighbor matrix since all missing row indices will be islands (see below).
colMissing
a vector of indices that are not present in object$col.id for the i-th matrix. This will be printed as "none" by the print method if there are no missing column indices and it is not printed at all if object is a symmetric spatial neighbor matrix since all missing column indices will be islands (see below).
islands
the indices for regions that have no neighbors. These indices do not appear in either the object$col.id or object$row.id for the i-th matrix. This will be printed as "none" by the print method if there are no islands.

DETAILS:

This function is a method for the generic function for class spatial.neighbor. It can be invoked by calling for an object x of the appropriate class, or directly by calling regardless of the class of the object.

SEE ALSO:

, .

EXAMPLES:

summary(sids.neighbor) 
# Create two symmetric spatial neighbor matrices with one island 
#   in the second matrix: 
ri <- c(1,1,2,3,4,5,1,1,2,5,5) 
ci <- c(2,3,3,4,5,6,2,3,3,3,6) 
mat <- c(1,1,1,1,1,1,2,2,2,2,2) 
sn <- spatial.neighbor(ri, ci, symm=T, matrix=mat) 
summary(sn)