prune.rivernet: Prune a river network at specified reaches

View source: R/prune.rivernet.r

prune.rivernetR Documentation

Prune a river network at specified reaches

Description

Prune a river network at specified reaches.

Usage

## S3 method for class 'rivernet'
prune(net,reach.up=numeric(0),reach.dn=numeric(0),verbose=TRUE)

Arguments

net

Object of class "rivernet" e.g. read by the function rivernet.read.

reach.up

Numerical vector of reach indices from which to prune all upstream reaches (the indicated reaches to prune from will be kept in the pruned network). Note that you can get reach indices from coordinates with the function getreachind.rivernet.

reach.dn

Numerical vector of reach indices from which to prune all downstream reaches and branches from downstream reaches (the indicated reaches to prune from will be kept in the pruned network). Note that you can get reach indices from coordinates with the function getreachind.rivernet.

verbose

Logical argument to specify whether there should be (minimal) output over what has been done.

Value

Returns pruned object of class "rivernet".

See Also

rivernet.read, rivernet.write,
upstreamconnectivity.rivernet, adjacentreaches.rivernet,
utility.


rivernet documentation built on Aug. 28, 2023, 5:06 p.m.