calculate_dci_dia: Calculate non-thresholded diadromous DCI

View source: R/calculate_dci.R

calculate_dci_diaR Documentation

Calculate non-thresholded diadromous DCI

Description

Calculate non-thresholded diadromous DCI

Usage

calculate_dci_dia(
  all_members,
  net_nodes,
  seg_weights,
  outlet_seg,
  parallel,
  quiet
)

Arguments

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.

outlet_seg

An integer indicating the membership label of the outlet segment

parallel

Logical. If FALSE, the default, all operations are performed in series. If TRUE parallel operation is performed using furrr::future_pmap(). Specify the number of workers and strategy using future::plan().

quiet

Logical. If FALSE, prints the global DCI and a plot of river segments to the console. Defaults to TRUE.

Value

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


dci documentation built on June 14, 2025, 1:08 a.m.