checkbraided: Check for Braiding in a River Network

Description Usage Arguments Note Author(s) Examples

View source: R/detectbraiding.R

Description

Detects braiding (multiple flow channels between two locations) within a river network object. Braiding can either be checked for in the route between two segments, or in the river network as a whole.

Usage

1
checkbraided(rivers, startseg = NULL, endseg = NULL, progress = TRUE)

Arguments

rivers

The river network object to check.

startseg

Starting segment of a route to investigate. If this and endseg are NULL, the full river network will be checked.

endseg

Starting segment of a route to investigate. If this and startseg are NULL, the full river network will be checked.

progress

Whether to show the progress bar. Defaults to TRUE.

Note

This function is called within cleanup, which is recommended in most cases.

Author(s)

Matt Tyers

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
data(Gulk)
plot(x=Gulk)
checkbraided(rivers=Gulk)

data(KilleyW)
plot(x=KilleyW)
checkbraided(rivers=KilleyW)

Kenai3.subset <- trimriver(trimto=c(22,2,70,30,15,98,96,89,52,3), rivers=Kenai3)
plot(x=Kenai3.subset)

checkbraided(startseg=1, endseg=7, rivers=Kenai3.subset)
checkbraided(startseg=1, endseg=5, rivers=Kenai3.subset)

riverdist documentation built on Sept. 10, 2021, 9:06 a.m.