ReadSimass: Read a 'simass.txt' file

In HYPEtools: Tools for Processing and Analyzing Files from the Hydrological Catchment Model HYPE

Read a 'simass.txt' file

Description

Import a HYPE simass.txt simulation assessment file as data frame into R. Simulation assessment files contain domain-wide aggregated performance criteria results, as defined in 'info.txt'.

Usage

ReadSimass(filename = "simass.txt")

Arguments

filename

Path to and file name of the 'simass.txt' file to import.

Details

ReadSimass imports a simulation assessment file into R. HYPE simass.txt files contain domain-wide performance measures for observed-simulated variable pairs as defined in HYPE info.txt files.

The function interprets character-coded time steps (e.g. "DD" for daily time steps), as used in some HYPE versions. Sub-daily time steps are currently not treated and will probably result in a warning during time step evaluation within the function. Please contact the developers if you need support for sub-daily time steps!

Value

ReadSubass returns a data frame with columns for HYPE variable names (observed, simulated), aggregation periods, and performance measure values of evaluated variable pairs. Aggregation periods are coded as in info.txt files, i.e. 1 = daily, 2 = weekly, 3 = monthly, 4 = annual. Metadata is added to the data frame as additional attributes:

• names.long, character vector with long names, corresponding to abbreviations uses as actual column names

• n.simulation, integer, simulation number (e.g. with Monte Carlo simulations)

• crit.total, numeric, total criteria value

• crit.conditional, numeric, conditional criteria value

• threshold, integer, data limit threshold

See Also

ReadSubass

Examples

te <- ReadSimass(filename = system.file("demo_model",
"results", "simass.txt", package = "HYPEtools"))
te

HYPEtools documentation built on June 8, 2025, 11:02 a.m.