analyze {rivernet}

Analyzes the Network Structure of a River Network

Description

Analyzes the network structure of a river network stored as an object of type rivernet.

Usage

analyze(net,outlet.reach=NA,calc.streamorder=TRUE,verbose=TRUE)

Arguments

net

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

outlet.reach

Index or, in case of multiple subnets index vector, of outlet reach or outlet reaches. If not provided, the function identifies the outlet reach either by assuming coordinates are provided in downstream direction or from elevation information.

calc.streamorder

Logical variable to indicate whether streamorder should be calculated (after pruning top reaches (see prune.rivernet) it may be unwanted to calculate stream order by setting (new) top reaches to order one).

verbose

Logical variable to turn on and off summary output about the network structure read.

Value

The function returns an object of type rivernet that adds the following columns to the data frame attrib.reach of the object: subnet: index of sub-network,
n_start: number of reaches connected at the start end of the reach,
n_end: number of reaches connected at the end end of the reach,
endreach: logical variable indicating if the reach is only connected at one end,
outlet: logical variable indicating if the reach represents the outlet of the network,
headwater: logical variable indicating if the reach is a headwater,
downstream: logical variable indicating if the reach coordinates represent the downstream direction,
reach_down: index of reach downstream of the reach,
streamorder: stream order of the reach.

In addition, the list of reaches (reaches) and the list of nodes (nodes) are appended by indices from_node, to_node and from_reach, to_reach, respectively. Finally, a list of all paths from the headwaters to the outlet is provided;
paths: list of vectors of reach indices of the paths from all sources to the outlet.

See Also

rivernet.read, mean.rivernet, adjacentreaches.rivernet,
utility.