gather_dci: Calculate sub-segmental DCI component between a single pair...

View source: R/calculate_dci.R

gather_dciR Documentation

Calculate sub-segmental DCI component between a single pair of segments

Description

Calculate sub-segmental DCI component between a single pair of segments

Usage

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

Arguments

net

A river_net object.

from

The origin segment's membership label.

to

The destination segment's membership label.

distance

The distance, in map units, between the two segments as calculated by gather_dist.

pass

The passability between the two segments as calculated by gather_perm.

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.

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.

weighted

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

Value

The sub-segmental DCI component between given pair of segments.


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