set_B_directionality: Calculates average upstream/downstream or combined distance...

View source: R/set_B_directionality.R

set_B_directionalityR Documentation

Calculates average upstream/downstream or combined distance between each couple of reaches

Description

Calculates average upstream/downstream or combined distance between each couple of reaches

Usage

set_B_directionality(
  graph,
  dir_distance_type = "symmetric",
  field_B = "length"
)

Arguments

graph

an object of class igraph. Can be both directed or undirected.

dir_distance_type

how directionality in B_ij calculations is dealt with: "symmetric" (i.e. undirected graph) or "asymmetric" (i.e. directed graph). See details.

field_B

the 'graph' edge attribute to be used to calculate the distance. Default is "length".

Value

an object of class 'igraph' with the upstream/downstream/total distances stored as edges attributes.


riverconn documentation built on May 31, 2023, 8:02 p.m.