fn_ALL.upstream: fn_ALL.upstream

In HARPgroup/hydro-tools: Data processing and accessors for VAHydro

fn_ALL.upstream

Description

Returns a vector of the segments upstream of riv.seg based on the list in AllSegList

Usage

fn_ALL.upstream(AllSegList, riv.seg = NULL, getAllSegmentsOnly = TRUE)

Arguments

AllSegList	Data frame that must contain riverseg and all river segments in state. All columns are maintained in final This function can only find segments that are in this list so the user should use a comprehensive list of segments as demonstrated in the hydrotools package in cia_utils.R
riv.seg	If user wishes to only return certain segments, they can specify these in riv.seg to get a data frame showing that segment, other data in AllSegList, and all upstream segments. May be left as NULL to instead find upstream segments of all unique segments in AllSegList
getAllSegmentsOnly	If the user only wishes to get the ids of upstream segments and the outlet i.e. this is inclusive of riv.seg. This may only be used if riv.seg is specified. Defaults to TRUE.

Details

Find Upstream Segments: A basic function that finds the segments upstream of a given segment(s). riv.seg may be a character vector of segments. and AllSegList must be a dataframe. This function returns a vector of upstream segments

Value

string next upstream segment ID

HARPgroup/hydro-tools documentation built on July 4, 2025, 11:05 a.m.