R: Calculate geodesic distance distribution for a network or...

ergm.geodistdist {ergm} | R Documentation

## Calculate geodesic distance distribution for a network or edgelist

### Description

`ergm.geodistdist` calculates geodesic distance distribution for a given `network` and returns it as a vector.

`ergm.geodistn` calculates geodesic deistance distribution based on an input edgelist, and has very little error checking so should not normally be called by users. The C code requires the edgelist to be directed and sorted correctly.

### Usage

    ergm.geodistdist(nw, directed = is.directed(nw))

    ergm.geodistn(edgelist, n = max(edgelist), directed = FALSE)

### Arguments

`nw` | `network` object over which distances should be calculated
`directed` | logical, should the network be treated as directed
`edgelist` | an edgelist representation of a network as an mx2 matrix
`n` | integer, size of the network

### Details

`ergm.geodistdist` is a network wrapper for `ergm.geodistn`, which calculates and returns the geodesic distance distribution for a given network via full_geodesic_distribution.C

### Value

a vector `ans` with length equal to the size of the network where

- `ans[i], i=1, ..., n-1` is the number of pairs of geodesic length `i`

- `ans[n]` is the number of pairs of geodesic length infinity.

### See Also

See also the sna package `geodist` function

### Examples

    data(faux.mesa.high)
    ergm.geodistdist(faux.mesa.high)

[Package ergm version 4.2.2 Index]