HypeGeoData {HYPEtools}

HypeGeoData data frames

Description

Constructor function for data frames which hold HYPE GeoData tables with information on sub-basins.

Usage

HypeGeoData(x)

Arguments

x

Data frame with at least five mandatory columns, see details.

Details

S3 constructor function for data frames which hold HYPE GeoData tables. These are normal data frames with at least five mandatory columns, all numeric: AREA, SUBID, MAINDOWN, RIVLEN, and SLC_n, where n are consecutive SLC class numbers (up to 999).See also the HYPE file description for GeoData.txt files for reference.

Usually, this class will be assigned to GeoData tables on import with ReadGeoData. A summary method exists for HypeGeoData data frames.

Value

Returns a data frame with added class attribute HypeGeoData.

See Also

ReadGeoData

Examples

te <- data.table::fread(file = system.file("demo_model",
"GeoData.txt", package = "HYPEtools"), data.table = FALSE)
HypeGeoData(x = te)
summary(te)