calculate_dci_pot_thresh: Calculate thresholded potamodromous DCI

In aarkilanian/dci: Calculate the Dendritic Connectivity in River Networks

Calculate thresholded potamodromous DCI

Description

Calculate thresholded potamodromous DCI

Usage

calculate_dci_pot_thresh(
  net,
  all_members,
  net_nodes,
  seg_weights,
  weighted,
  threshold,
  totweight,
  n.cores,
  quiet
)

Arguments

net	A river_net object.
all_members	An integer vector holding all assigned membership labels in the river_net object.
net_nodes	An sf object of the nodes of the river_net object with river attributes joined.
seg_weights	A data frame of each segments total length. Either weighted or unweighted depending on parameters.
weighted	A logical value indicating whether river lengths in seg_weights are weighted.
threshold	An optional numeric value specifying a dispersal limit in map units. If NULL, the default, no limit is considered.
totweight	The total length or weighted length of the whole network.
n.cores	An optional integer value indicating the number of cores to use. Defaults to 1. Currently only works on MacOS and Linux.
quiet	A logical value indicating whether the global DCI and a map of segments should be printed to the console. Defaults to TRUE.

Value

A data frame which holds raw and relative DCI scores for each segment.

aarkilanian/dci documentation built on Feb. 5, 2024, 7:12 p.m.