list_all_nds: Identify the next downstream site for each site in a list of...

Description Usage Arguments Value Note Examples

View source: R/list_all_nds.R

Description

Identify the next downstream site for each site in a list of sites.

Usage

1
list_all_nds(hierarchy, catchnames, candidates)

Arguments

hierarchy

a dataframe containing catchment id and next downstream (nextds) id fields

catchnames

a vector of catchment ids (sites) for which a a list of downstream catchments ids will be returned.

candidates

a vector of candidate catchment ids. Note this need not be a complete hierarchy

Value

a list of downstream catchment ids for each catchment in catchnames. Returns -1 where there is no downstream site

Note

Function depends on the next downstream field in a stream network 'hierarchy' table (dataframe). Can be used to support further aggregation of environmental variables for sub-catchments downstream of a list of catchments of interest (e.g. for calculating barrier numbers).

Examples

1
2
3
4
5
6
7
data(mwcats)

#find next downstream sites from a list of candidates for a list of sites
data(mwcats)

list_all_nds(hierarchy = mwcats[,c(1:2)], catchnames = mwcats$site[1:5],
candidates=sample(mwcats$site, size = 4000))

nickbond/catchstats documentation built on Nov. 22, 2019, 3:41 a.m.