HYPEtools1.6.6 package

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

AllDownstreamSubids

Find All Downstream SUBIDs

AllUpstreamSubids

Find All Upstream SUBIDs

AnnualRegime

Calculate annual regimes

BarplotUpstreamClasses

Bar plots of upstream-averaged classes of HYPE sub-basins

BoxplotSLCClasses

Box plots of SLC distributions

CleanSLCClasses

Clean Soil-Landuse classes (SLCs) from small fractions

CompareFiles

Compare HYPE model files to identify any differences.

ConvertDischarge

Calculate Specific runoff from volumetric discharge and vice versa

CreateOptpar

Create an optpar list

CustomColors

Custom color ramp palettes

DirectUpstreamSubids

Find Direct Upstream SUBIDs, with Flow Fractions

distinctColorPalette

Generate optimally distinct color palettes

EquallySpacedObs

Create an equally spaced time series from irregular observations

ExtractFreq

Extract quantiles for use in a frequency distribution plot, e.g. a flo...

ExtractStats

Extract statistics from time series

GOF

Goodness of Fit Functions

GroupSLCClasses

Calculate grouped sums for SLC classes in a GeoData file

GwRetention

Calculate groundwater retention of nutrients

HeadwaterSubids

Find all headwater SUBIDs of a model domain

HypeAttrAccess

Quickly query and set HYPE-specific attributes

HypeDataExport

Write HYPE data files

HypeDataImport

Read HYPE data files

HypeGeoData

HypeGeoData data frames

HypeMultiVar

HypeMultiVar arrays

HypeSingleVar

HypeSingleVar arrays

HypeSubidChecks

Check HYPE SUBID properties

HYPEtools-package

HYPEtools: Tools for Processing and Analyzing Files from the Hydrologi...

HypeXobs

HypeXobs data frames

InfoManipulation

Functions to Manipulate HYPE Info Files

MapRegionalSources

Map regional irrigation source connection as spatial lines

merge

Merge HypeGeoData object

MergeObs

Merge two HYPE observation data frames

MergeXobs

Merge two Xobs data frames

NSE.HypeSingleVar

Nash-Sutcliffe Efficiency

OptimisedClasses

Get optimized classes from an imported optpar.txt file

OutletIds

Find Outlet IDs

OutletNearObs

Find outlet-near observations in HYPE observation data files.

OutletSubids

Find all Outlet SUBIDs of a model domain

PartyParrot

Create a Party Parrot.

pbias.HypeSingleVar

Percent bias

PlotAnnualRegime

Plot annual regimes

PlotBasinOutput

Plot a suite of time series plots from a HYPE basin output file

PlotBasinSummary

Plot a summary of model results for a single sub-basin

PlotDurationCurve

Plot duration curves

PlotMapOutput

Plot function for HYPE map results.

PlotMapPoints

Plot function for mapped point information

PlotPerformanceByAttribute

Plot model performance by SUBID attributes

PlotSimObsRegime

Plot annual regimes of simulated and observed variables

PlotSubbasinRouting

Plot HYPE model subbasin routing.

r

Pearson product-moment correlation coefficient r

ReadBasinOutput

Read a Basin Output File

ReadClassData

Read a 'ClassData.txt' File

ReadDescription

Read a 'description.txt' file

ReadGeoClass

Read a 'GeoClass.txt' File

ReadGeoData

Read a 'GeoData.txt' file

ReadInfo

Read an 'info.txt' file

ReadMapOutput

Read a Map Output File

ReadObs

Read HYPE observation data files

ReadOptpar

Read an 'optpar.txt' file

ReadPar

Read a 'par.txt' file

ReadPmsf

Read a 'pmsf.txt' file

ReadSimass

Read a 'simass.txt' file

ReadSubass

Read a 'subassX.txt' file

ReadTimeOutput

Read a Time Output File

ReadWsOutput

Read optimization simulation results

ReadXobs

Read an 'Xobs.txt' file

RescaleSLCClasses

Re-scale SLC classes in a GeoData data frame

RunHYPE

Run HYPE model

ScaleAquiferData

Scale 'AquiferData.txt' files to different model time steps

ScaleFloodData

Scale 'FloodData.txt' files to different model time steps

ScalePar

Scale 'par.txt' files to different model time step

SimToPar

HYPE Calibration Outputs to par.txt

SortGeoData

Sort a GeoData dataframe in downstream order

SubidAttributeSummary

Summarize subbasin attributes

SumSLCClasses

Calculate sums of SLC classes in a GeoData file

SumUpstreamArea

Calculate upstream area sums

UpstreamGeoData

Calculate upstream sums and averages of selected GeoData contents

UpstreamGroupSLCClasses

Calculate area-weighted upstream averages of grouped SLC class fractio...

UpstreamPointSources

Summarize point source emissions of all upstream areas

UpstreamSLCClasses

Calculate SLC class fractions of all upstream areas

VariableLookup

Lookup Functions For HYPE Variables

VisualizeMapOutput

Shiny App for visualizing HYPE MapOutputs.

VisualizeMapPoints

Shiny App for visualizing Mapped Point Information.

WriteBasinOutput

Write a basin output '[SUBID].txt' file

WriteGeoClass

Write a 'GeoClass.txt' file

WriteGeoData

Write a 'GeoData.txt' file

WriteHarmonizedData

Write a Harmonized Data File

WriteHarmonizedSpatialDescription

Write a Harmonized Spatial Description File

WriteInfo

Write a 'info.txt' File

WriteMapOutput

Write a 'mapXXXX.txt' file

WriteObs

Write 'Pobs.txt', 'Tobs.txt', 'Qobs.txt', and other observation data f...

WriteOptpar

Write an 'optpar.txt' File

WritePar

Write a 'par.txt' File

WritePmsf

Write a 'pmsf.txt' file

WriteTimeOutput

Write a 'timeXXXX.txt' file

WriteXobs

Write an 'Xobs.txt' File

Work with model files (setup, input, output) from the hydrological catchment model HYPE: Streamlined file import and export, standard evaluation plot routines, diverse post-processing and aggregation routines for hydrological model analysis. The HYPEtools package is also archived at <doi:10.5281/zenodo.7627955> and can be cited in publications with Brendel et al. (2024) <doi:10.1016/j.envsoft.2024.106094>.

  • Maintainer: Rene Capell
  • License: LGPL-3
  • Last published: 2025-08-19