DistGraph {SANTA} | R Documentation

## Compute the vertex pair distance matrix for a graph

### Description

Compute the distances between pairs of vertices in a graph, using a shortest path, diffusion kernel, or mean first-passage time-based measure.

### Usage

    DistGraph(g, v=V(g), edge.attr=NULL, dist.method=c("shortest.paths", "diffusion", "mfpt"),
    correct.inf=TRUE, correct.factor=1, verbose=TRUE)

### Arguments

`g` | `igraph` object, the graph on which to work.
`v` | `igraph` object or numeric vector, the vertices from which each distance is calculated.
`edge.attr` | String, the name of the edge attribute to be used as distances along the edges. If `NULL`, then each edge is assumed to have a distance of 1. Smaller edge distances denote stronger interactions between vertex pairs.
`dist.method` | String, the method used to compute the distance between each vertex pair.
`correct.inf` | Logical, if `TRUE` then infinite vertex pair distances are replaced with distances equal to the maximum distance measured across the network, multiplied by `correct.factor`.
`correct.factor` | Numeric value, if the graph contains unconnected vertices, then the distance between these vertices is set as the maximum distance between the connected vertices multiplied by `correct.factor`.
`verbose` | Logical, if `TRUE` messages about the progress of the function are displayed.

### Details

This function computes a distance matrix for a graph. Different methods can be used to calculate the distance between each pair of vertices. If a set of vertices is specified, a smaller distance matrix containing only vertices corresponding to the vertices is returned.

Descriptions of how the shortest paths (`shortest.paths`), diffusion kernel-based (`GraphDiffusion`) and mean first-passage time (`GraphMFPT`) distance measures work are given in their respective function descriptions.

### Value

Numeric matrix, containing the distances between vertex pairs.

### Author(s)

Alex J. Cornish a.cornish12@imperial.ac.uk

### References

Kondor, R.I. and Lafferty, J. (2002). Diffusion Kernels on Graph and Other Discrete Structures. Proc. Intl. Conf. Machine Learning.

White, S. and Smyth, P. (2003). Algorithms for Estimating Relative Importance in Networks. Technical Report UCI-ICS 04-25.

### See Also

`shortest.paths`, `GraphDiffusion`, `GraphMFPT`

### Examples

    # create a graph and compute the distance matrix using the shortest paths measure
    g1 <- barabasi.game(6, directed=FALSE)
    DistGraph(g1, dist.method="shortest.paths")
    plot(g1, layout=layout.fruchterman.reingold)

    # create a graph, assign edge distances and compute the distance matrix using the
    # diffusion kernel-based measure
    g2 <- erdos.renyi.game(6, p.or.m=0.5, directed=FALSE)
    g2 <- set.edge.attribute(g2, name="distance", value=runif(ecount(g2)))
    DistGraph(g2, dist.method="diffusion", edge.attr="distance")
    plot(g2, layout=layout.fruchterman.reingold)

[Package SANTA version 2.22.0 Index]