riverconn (version 0.3.31)

set_c_directionality: Calculates equivalent passability based on graph directionality and directionality type

Description

Calculates equivalent passability based on graph directionality and directionality type

Usage

set_c_directionality(
  graph,
  dir_fragmentation_type = "symmetric",
  pass_confluence = 1,
  pass_u = "pass_u",
  pass_d = "pass_d"
)

Value

an object of class 'igraph' with the equivalent passability stored in the edge attribute 'pass_eq'

Arguments

graph

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

dir_fragmentation_type

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

pass_confluence

a value in the range [0,1] that defines the passability of confluences (default is 1).

pass_u

the 'graph' edge attribute to be used as upstream passability. Default is "pass_u".

pass_d

the 'graph' edge attribute to be used as downstream passability. Default is "pass_d".