Obtain the Neighborhood of a Given Vertex

get.neighborhood returns the IDs of all vertices belonging to the in, out, or combined neighborhoods of v within network x.

Usage

get.neighborhood(x, v, type = c("out", "in", "combined"), na.omit = TRUE, ...)

# S3 method for class 'network'
get.neighborhood(x, v, type = c("out", "in", "combined"), na.omit = TRUE, ...)

Arguments

x: an object of class network
v: a vertex ID
type: the neighborhood to be computed
na.omit: logical; should missing edges be ignored when obtaining vertex neighborhoods?
...: additional arguments to methods

Value

A vector containing the vertex IDs for the chosen neighborhood.

Details

Note that the combined neighborhood is the union of the in and out neighborhoods – as such, no vertex will appear twice.

References

Butts, C. T. (2008). “network: a Package for Managing Relational Data in R.” Journal of Statistical Software, 24(2). doi:10.18637/jss.v024.i02

Wasserman, S. and Faust, K. 1994. Social Network Analysis: Methods and Applications. Cambridge: Cambridge University Press.

Author

Carter T. Butts buttsc@uci.edu

Examples


#Create a network with three edges
m<-matrix(0,3,3)
m[1,2]<-1; m[2,3]<-1; m[3,1]<-1
g<-network(m)

#Examine the neighborhood of vertex 1
get.neighborhood(g,1,"out")
#> [1] 2
get.neighborhood(g,1,"in")
#> [1] 3
get.neighborhood(g,1,"combined")
#> [1] 3 2