riverdistancemat: River Distance Matrix

Description

Returns a matrix of distances between every point and every other point of given river locations (segment and vertex), or of a subset.

Usage

riverdistancemat(
  seg,
  vert,
  rivers,
  logical = NULL,
  ID = NULL,
  stopiferror = TRUE,
  algorithm = NULL
)

Value

A matrix of distances (numeric) with rows and columns labeled by corresponding values of ID.

Arguments

seg: A vector of river locations (segment component).
vert: A vector of river locations (vertex component).
rivers: The river network object to use.
logical: A boolean vector that can be used for subsetting. If used, riverdistancemat will only return pairwise distances in which a specified condition is met.
ID: a vector of observation IDs for aid in interpreting the output table
stopiferror: Whether or not to exit with an error if a route cannot be found. If this is set to FALSE and a route cannot be found, the function will return NA in the appropriate entry. Defaults to TRUE. See detectroute
algorithm: Which route detection algorithm to use ("Dijkstra", "sequential", or "segroutes"). If left as NULL (the default), the function will automatically make a selection. See detectroute for more details.

Author

Matt Tyers

Examples

Run this code

data(Gulk, fakefish)

logi1 <- (fakefish$flight.date==as.Date("2015-11-25"))

riverdistancemat(seg=fakefish$seg, vert=fakefish$vert, rivers=Gulk, logical=logi1)

Run the code above in your browser using DataLab

Last chance! 50% off unlimited learning