calculate_dci_dia_thresh: Calculate thresholded diadromous DCI

View source: R/calculate_dci.R

calculate_dci_dia_threshR Documentation

Calculate thresholded diadromous DCI

Description

Calculate thresholded diadromous DCI

Usage

calculate_dci_dia_thresh(
  net,
  all_members,
  net_nodes,
  seg_weights,
  weighted,
  threshold,
  totweight,
  outlet_seg,
  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.

outlet_seg

An integer indicating the membership label of the outlet segment

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.


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