OutletSubids {HYPEtools}

Find all Outlet SUBIDs of a model domain

Description

Function to find all outlet SUBIDs of a HYPE model domain.

Usage

OutletSubids(gd)

Arguments

gd

A data frame, with two columns subid and maindown, (not case-sensitive). Typically a 'GeoData.txt' file imported using ReadGeoData.

Details

OutletSubids finds all outlet SUBIDs of a model domain as provided in a 'GeoData.txt' file, i.e. all SUBIDs from which stream water leaves the model domain.

Value

OutletSubids returns a vector of outlet SUBIDs.

See Also

AllDownstreamSubids, OutletIds

Examples

te <- ReadGeoData(filename = system.file("demo_model", "GeoData.txt", package = "HYPEtools"))
OutletSubids(gd = te)