secrlinear (version 1.2.4)

showpath: Display Shortest Path

Description

An interactive function to examine shortest paths and the associated network distances within a linear mask.

Usage

showpath(mask, add = FALSE, ...)

Value

Invisibly returns a list comprising

paths

a list of dataframes, each with the mask coordinates along a selected path

results

a dataframe with one row for each path giving the distances for each pair of points (columns `from', `to', `Euclidean.d', `network.d')

.

Arguments

mask

linearmask object

add

logical; if TRUE the plot is added to an existing plot

...

other arguments passed to lines for drawing network path

Details

The selected points are snapped to the nearest mask point before any calculations.

The path shown is a shortest path as determined by function get.shortest.paths of the igraph package. There may be others.

References

Csardi, G. and Nepusz, T. (2006) The igraph software package for complex network research, InterJournal, Complex Systems 1695. https://igraph.org/.

See Also

networkdistance

Examples

if (FALSE) {

x <- seq(0, 4*pi, length = 200)
xy <- data.frame(x = x*100, y = sin(x)*300)
xy2 <- data.frame(x = x*100, y = cos(x)*300)
test <- read.linearmask(data = xy, spacing = 10)
test2 <- read.linearmask(data = xy2, spacing = 10)
test3 <- rbind(test, test2)
showpath(test3, lwd = 5)

}