gather_dci: Calculate thresholded invasive DCI

View source: R/calculate_dci.R

gather_dciR Documentation

Calculate thresholded invasive DCI

Description

Calculate thresholded invasive DCI

Usage

gather_dci(
  net,
  form,
  from,
  to,
  distance,
  pass,
  nodes,
  seg_weights,
  threshold,
  totweight,
  weighted
)

Arguments

net

A river_net object.

form

A string specifying the DCI form to calculate. Options are: "pot" for potamodromous or "dia" for diadromous.

pass

The name of a column in the nodes table of net containing numeric passability values. If NULL, all barriers are assumed to have 0 passability.

threshold

Optional numeric value specifying a dispersal limit in map units. If NULL (default), no limit is applied.

totweight

The total length or weighted length of the whole network.

weighted

A logical value indicating whether river lengths in seg_weights are weighted.

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.