Learn R Programming

HYPEtools (version 1.6.4)

OutletIds: Find Outlet IDs

Description

Function to find the identifier(s) used to signify model domain outlets, i.e. the "downstream" ID of outlet catchments, in a GeoData file. This is typically just one number, often e.g. '0' or '-9999', but can be one or several IDs if the GeoData file originates from a HYPE sub-model set-up, e.g. created with the 'SelectAro' program. Use OutletSubids to find the actual SUBID values of the outlet catchments.

Usage

OutletIds(gd)

Value

OutletIds returns a vector of outlet IDs.

Arguments

gd

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

Details

OutletIds finds the unique outlet IDs of a GeoData file. The outlet ID of a typical model is a single placeholder number, often e.g. '0' or '-9999', but there can be several outlet IDs, e.g. one or several SUBIDs if the GeoData file originates from a HYPE sub-model set-up, created with the 'SelectAro' tool.

See Also

AllDownstreamSubids, OutletSubids

Examples

Run this code
te <- ReadGeoData(filename = system.file("demo_model", "GeoData.txt", package = "HYPEtools"))
OutletIds(gd = te)

Run the code above in your browser using DataLab