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

## Documentation for package ‘HYPEtools’ version 1.6.7

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

A B C D E G H I K M N O P R S T U V W

## -- A --

AddInfoLine | Functions to Manipulate HYPE Info Files
AllDownstreamSubids | Find All Downstream SUBIDs
AllSimToPar | HYPE Calibration Outputs to par.txt
AllUpstreamSubids | Find All Upstream SUBIDs
AnnualRegime | Calculate annual regimes

## -- B --

BarplotUpstreamClasses | Bar plots of upstream-averaged classes of HYPE sub-basins
BestSimsToPar | HYPE Calibration Outputs to par.txt
BoxplotSLCClasses | Box plots of SLC distributions

## -- C --

CleanSLCClasses | Clean Soil-Landuse classes (SLCs) from small fractions
ColBlues | Custom color ramp palettes
ColDiffGeneric | Custom color ramp palettes
ColDiffTemp | Custom color ramp palettes
ColGreens | Custom color ramp palettes
ColNitr | Custom color ramp palettes
ColPhos | Custom color ramp palettes
ColPrec | Custom color ramp palettes
ColPurples | Custom color ramp palettes
ColQ | Custom color ramp palettes
ColReds | Custom color ramp palettes
ColTemp | Custom color ramp palettes
ColYOB | Custom color ramp palettes
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

## -- D --

datetime | Quickly query and set HYPE-specific attributes
datetime<- | Quickly query and set HYPE-specific attributes
DirectUpstreamSubids | Find Direct Upstream SUBIDs, with Flow Fractions
distinctColorPalette | Generate optimally distinct color palettes

## -- E --

EquallySpacedObs | Create an equally spaced time series from irregular observations
ExtractFreq | Extract quantiles for use in a frequency distribution plot, e.g. a flow duration curve
ExtractStats | Extract statistics from time series

## -- G --

GOF | Goodness of Fit Functions
gof | Goodness of Fit Functions
gof.default | Goodness of Fit Functions
GroupSLCClasses | Calculate grouped sums for SLC classes in a GeoData file
GwRetention | Calculate groundwater retention of nutrients

## -- H --

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
hypeunit | Quickly query and set HYPE-specific attributes
hypeunit<- | Quickly query and set HYPE-specific attributes
HypeXobs | HypeXobs data frames

## -- I --

InfoManipulation | Functions to Manipulate HYPE Info Files
IsHeadwater | Check HYPE SUBID properties
IsOutlet | Check HYPE SUBID properties
IsRegulated | Check HYPE SUBID properties

## -- K --

KGE | Goodness of Fit Functions
KGE.default | Goodness of Fit Functions

## -- M --

mae | Goodness of Fit Functions
mae.default | Goodness of Fit Functions
MapRegionalSources | Map regional irrigation source connection as spatial lines
merge | Merge HypeGeoData object
merge.HypeGeoData | Merge HypeGeoData object
MergeObs | Merge two HYPE observation data frames
MergeXobs | Merge two Xobs data frames

## -- N --

NSE | Goodness of Fit Functions
NSE.default | Goodness of Fit Functions
NSE.HypeSingleVar | Nash-Sutcliffe Efficiency

## -- O --

obsid | Quickly query and set HYPE-specific attributes
obsid<- | Quickly query and set HYPE-specific attributes
OptimisedClasses | Get optimized classes from an imported optpar.txt file
OptimizedClasses | 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
outregid | Quickly query and set HYPE-specific attributes
outregid<- | Quickly query and set HYPE-specific attributes

## -- P --

PartyParrot | Create a Party Parrot.
pbias | Goodness of Fit Functions
pbias.default | Goodness of Fit Functions
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
PlotEvaluationMaps | Function for plotting up to two HYPE simulation results in maps.
PlotJohan | Plot model performance by SUBID attributes
PlotMapOutput | Plot function for HYPE map results.
PlotMapPoints | Plot function for mapped point information
PlotParValues | Plot HYPE model parameter values.
PlotPerformanceByAttribute | Plot model performance by SUBID attributes
PlotSimObsRegime | Plot annual regimes of simulated and observed variables
PlotSubbasinRouting | Plot HYPE model subbasin routing.

## -- R --

r | Pearson product-moment correlation coefficient r
r.HypeSingleVar | Pearson product-moment correlation coefficient r
ReadAllsim | Read HYPE data files
ReadAquiferData | Read HYPE data files
ReadBasinOutput | Read a Basin Output File
ReadBranchData | Read HYPE data files
ReadClassData | Read a 'ClassData.txt' File
ReadCropData | Read HYPE data files
ReadDamData | Read HYPE data files
ReadDescription | Read a 'description.txt' file
ReadFloodData | Read HYPE data files
ReadForcKey | Read HYPE data files
ReadGeoClass | Read a 'GeoClass.txt' File
ReadGeoData | Read a 'GeoData.txt' file
ReadGlacierData | Read HYPE data files
ReadInfo | Read an 'info.txt' file
ReadLakeData | Read HYPE data files
ReadMapOutput | Read a Map Output File
ReadMgmtData | Read HYPE data files
ReadObs | Read HYPE observation data files
ReadOptpar | Read an 'optpar.txt' file
ReadOutregions | Read HYPE data files
ReadPar | Read a 'par.txt' file
ReadPmsf | Read a 'pmsf.txt' file
ReadPointSourceData | Read HYPE data files
ReadPTQobs | Read HYPE observation data files
ReadSimass | Read a 'simass.txt' file
ReadSubass | Read a 'subassX.txt' file
ReadTimeOutput | Read a Time Output File
ReadUpdate | Read HYPE data files
ReadWsOutput | Read optimization simulation results
ReadXobs | Read an 'Xobs.txt' file
RemoveInfoLine | Functions to Manipulate HYPE Info Files
RescaleSLCClasses | Re-scale SLC classes in a GeoData data frame
rPearson | Goodness of Fit Functions
rPearson.default | Goodness of Fit Functions
RunHYPE | Run HYPE model

## -- S --

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
sKGE | Goodness of Fit Functions
sKGE.default | Goodness of Fit Functions
SortGeoData | Sort a GeoData dataframe in downstream order
subid | Quickly query and set HYPE-specific attributes
subid<- | Quickly query and set HYPE-specific attributes
SubidAttributeSummary | Summarize subbasin attributes
SumSLCClasses | Calculate sums of SLC classes in a GeoData file
SumUpstreamArea | Calculate upstream area sums

## -- T --

timestep | Quickly query and set HYPE-specific attributes
timestep<- | Quickly query and set HYPE-specific attributes

## -- U --

UpstreamGeoData | Calculate upstream sums and averages of selected GeoData contents
UpstreamGroupSLCClasses | Calculate area-weighted upstream averages of grouped SLC class fractions.
UpstreamPointSources | Summarize point source emissions of all upstream areas
UpstreamSLCClasses | Calculate SLC class fractions of all upstream areas

## -- V --

valindex | Goodness of Fit Functions
valindex.default | Goodness of Fit Functions
variable | Quickly query and set HYPE-specific attributes
variable<- | Quickly query and set HYPE-specific attributes
VariableInfo | Lookup Functions For HYPE Variables
VariableLookup | Lookup Functions For HYPE Variables
VariableSearch | Lookup Functions For HYPE Variables
VE | Goodness of Fit Functions
VE.default | Goodness of Fit Functions
VisualiseMapOutput | Shiny App for visualizing HYPE MapOutputs.
VisualiseMapPoints | Shiny App for visualizing Mapped Point Information.
VisualizeMapOutput | Shiny App for visualizing HYPE MapOutputs.
VisualizeMapPoints | Shiny App for visualizing Mapped Point Information.

## -- W --

WriteAquiferData | Write HYPE data files
WriteBasinOutput | Write a basin output '[SUBID].txt' file
WriteBranchData | Write HYPE data files
WriteCropData | Write HYPE data files
WriteDamData | Write HYPE data files
WriteFloodData | Write HYPE data files
WriteForcKey | Write HYPE data files
WriteGeoClass | Write a 'GeoClass.txt' file
WriteGeoData | Write a 'GeoData.txt' file
WriteGlacierData | Write HYPE data files
WriteHarmonizedData | Write a Harmonized Data File
WriteHarmonizedSpatialDescription | Write a Harmonized Spatial Description File
WriteInfo | Write a 'info.txt' File
WriteLakeData | Write HYPE data files
WriteMapOutput | Write a 'mapXXXX.txt' file
WriteMgmtData | Write HYPE data files
WriteObs | Write 'Pobs.txt', 'Tobs.txt', 'Qobs.txt', and other observation data files
WriteOptpar | Write an 'optpar.txt' File
WriteOutregions | Write HYPE data files
WritePar | Write a 'par.txt' File
WritePmsf | Write a 'pmsf.txt' file
WritePointSourceData | Write HYPE data files
WritePTQobs | Write 'Pobs.txt', 'Tobs.txt', 'Qobs.txt', and other observation data files
WriteTimeOutput | Write a 'timeXXXX.txt' file
WriteXobs | Write an 'Xobs.txt' File