Package: HYPEtools 1.6.7

Rene Capell

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

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>.

Authors:Rene Capell [aut, cre], Conrad Brendel [aut], Jafet Andersson [ctb], David Gustafsson [ctb], Jude Musuuza [ctb], Jude Lubega [ctb]

HYPEtools_1.6.7.tar.gz
HYPEtools_1.6.7.zip(r-4.7)HYPEtools_1.6.7.zip(r-4.6)HYPEtools_1.6.7.zip(r-4.5)
HYPEtools_1.6.7.tgz(r-4.6-any)HYPEtools_1.6.7.tgz(r-4.5-any)
HYPEtools_1.6.7.tar.gz(r-4.7-any)HYPEtools_1.6.7.tar.gz(r-4.6-any)
HYPEtools_1.6.7.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
HYPEtools/json (API)
NEWS

# Install 'HYPEtools' in R:

install.packages('HYPEtools', repos = c('https://rcapell.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/rcapell/hypetools/issues

On CRAN:

7.87 score 21 stars 27 scripts 596 downloads 159 exports 84 dependencies

Last updated from:5c642c72a7. Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	227
source / vignettes	OK	318
linux-release-x86_64	OK	215
macos-release-arm64	OK	235
macos-oldrel-arm64	OK	356
windows-devel	OK	182
windows-release	OK	583
windows-oldrel	OK	179
wasm-release	OK	154

Exports:AddInfoLine AllDownstreamSubids AllSimToPar AllUpstreamSubids AnnualRegime BarplotUpstreamClasses BestSimsToPar BoxplotSLCClasses CleanSLCClasses ColBlues ColDiffGeneric ColDiffTemp ColGreens ColNitr ColPhos ColPrec ColPurples ColQ ColReds ColTemp ColYOB CompareFiles ConvertDischarge CreateOptpar datetime datetime<-DirectUpstreamSubids distinctColorPalette EquallySpacedObs ExtractFreq ExtractStats gof GroupSLCClasses GwRetention HeadwaterSubids HypeGeoData HypeMultiVar HypeSingleVar hypeunit hypeunit<-HypeXobs IsHeadwater IsOutlet IsRegulated KGE mae MapRegionalSources MergeObs MergeXobs NSE obsid obsid<-OptimisedClasses OptimizedClasses OutletIds OutletNearObs OutletSubids outregid outregid<-PartyParrot pbias PlotAnnualRegime PlotBasinOutput PlotBasinSummary PlotDurationCurve PlotEvaluationMaps PlotJohan PlotMapOutput PlotMapPoints PlotParValues PlotPerformanceByAttribute PlotSimObsRegime PlotSubbasinRouting r ReadAllsim ReadAquiferData ReadBasinOutput ReadBranchData ReadClassData ReadCropData ReadDamData ReadDescription ReadFloodData ReadForcKey ReadGeoClass ReadGeoData ReadGlacierData ReadInfo ReadLakeData ReadMapOutput ReadMgmtData ReadObs ReadOptpar ReadOutregions ReadPar ReadPmsf ReadPointSourceData ReadPTQobs ReadSimass ReadSubass ReadTimeOutput ReadUpdate ReadWsOutput ReadXobs RemoveInfoLine RescaleSLCClasses rPearson RunHYPE ScaleAquiferData ScaleFloodData ScalePar sKGE SortGeoData subid subid<-SubidAttributeSummary SumSLCClasses SumUpstreamArea timestep timestep<-UpstreamGeoData UpstreamGroupSLCClasses UpstreamPointSources UpstreamSLCClasses valindex variable variable<-VariableInfo VariableSearch VE VisualiseMapOutput VisualiseMapPoints VisualizeMapOutput VisualizeMapPoints WriteAquiferData WriteBasinOutput WriteBranchData WriteCropData WriteDamData WriteFloodData WriteForcKey WriteGeoClass WriteGeoData WriteGlacierData WriteHarmonizedData WriteHarmonizedSpatialDescription WriteInfo WriteLakeData WriteMapOutput WriteMgmtData WriteObs WriteOptpar WriteOutregions WritePar WritePmsf WritePointSourceData WritePTQobs WriteTimeOutput WriteXobs

Dependencies:abind backports boot broom car carData cli clipr colorspace corrplot cowplot cpp11 data.table Deriv doBy dplyr farver forecast Formula fracdiff generics ggplot2 ggpubr ggrepel ggsci ggsignif glue gridExtra gtable isoband labeling lattice lifecycle lme4 lmtest lubridate magrittr MASS Matrix MatrixModels mgcv microbenchmark minqa modelr ncdf4 nlme nloptr nnet numDeriv patchwork pbapply pbkrtest pillar pkgconfig polynom purrr quantreg R6 rbibutils RColorBrewer Rcpp RcppArmadillo RcppEigen Rdpack reformulas rlang rstatix S7 scales SparseM stringi stringr survival tibble tidyr tidyselect timechange timeDate urca utf8 vctrs viridisLite withr zoo

Analyze Catchment Area Characteristics

Rendered frombasin_characteristics.Rmdusingknitr::rmarkdownon May 09 2026.

Last update: 2022-08-30
Started: 2022-01-05

Analyze HYPE Time Series Outputs

Rendered fromanalyze_hype_ts.Rmdusingknitr::rmarkdownon May 09 2026.

Last update: 2022-08-30
Started: 2022-01-05

Analyze Spatial Patterns

Rendered fromplot_map_statistics.Rmdusingknitr::rmarkdownon May 09 2026.

Last update: 2023-04-21
Started: 2022-01-05

Basin Networks

Rendered frombasin_network.Rmdusingknitr::rmarkdownon May 09 2026.

Last update: 2022-09-01
Started: 2022-01-05

Import HYPE Files

Rendered fromimport_files.Rmdusingknitr::rmarkdownon May 09 2026.

Last update: 2024-05-23
Started: 2022-01-03

Modify a HYPE Parameter File

Rendered frommodify_par.Rmdusingknitr::rmarkdownon May 09 2026.

Last update: 2022-01-05
Started: 2022-01-05

Help page	Topics
Find All Downstream SUBIDs	AllDownstreamSubids
Find All Upstream SUBIDs	AllUpstreamSubids
Calculate annual regimes	AnnualRegime
Bar plots of upstream-averaged classes of HYPE sub-basins	BarplotUpstreamClasses
Box plots of SLC distributions	BoxplotSLCClasses
Clean Soil-Landuse classes (SLCs) from small fractions	CleanSLCClasses
Compare HYPE model files to identify any differences.	CompareFiles
Calculate Specific runoff from volumetric discharge and vice versa	ConvertDischarge
Create an optpar list	CreateOptpar
Custom color ramp palettes	ColBlues ColDiffGeneric ColDiffTemp ColGreens ColNitr ColPhos ColPrec ColPurples ColQ ColReds ColTemp ColYOB CustomColors
Find Direct Upstream SUBIDs, with Flow Fractions	DirectUpstreamSubids
Generate optimally distinct color palettes	distinctColorPalette
Create an equally spaced time series from irregular observations	EquallySpacedObs
Extract quantiles for use in a frequency distribution plot, e.g. a flow duration curve	ExtractFreq
Extract statistics from time series	ExtractStats
Goodness of Fit Functions	GOF gof gof.default KGE KGE.default mae mae.default NSE NSE.default pbias pbias.default rPearson rPearson.default sKGE sKGE.default valindex valindex.default VE VE.default
Calculate grouped sums for SLC classes in a GeoData file	GroupSLCClasses
Calculate groundwater retention of nutrients	GwRetention
Find all headwater SUBIDs of a model domain	HeadwaterSubids
Quickly query and set HYPE-specific attributes	datetime datetime<- HypeAttrAccess hypeunit hypeunit<- obsid obsid<- outregid outregid<- subid subid<- timestep timestep<- variable variable<-
Write HYPE data files	HypeDataExport WriteAquiferData WriteBranchData WriteCropData WriteDamData WriteFloodData WriteForcKey WriteGlacierData WriteLakeData WriteMgmtData WriteOutregions WritePointSourceData
Read HYPE data files	HypeDataImport ReadAllsim ReadAquiferData ReadBranchData ReadCropData ReadDamData ReadFloodData ReadForcKey ReadGlacierData ReadLakeData ReadMgmtData ReadOutregions ReadPointSourceData ReadUpdate
HypeGeoData data frames	HypeGeoData
HypeMultiVar arrays	HypeMultiVar
HypeSingleVar arrays	HypeSingleVar
Check HYPE SUBID properties	HypeSubidChecks IsHeadwater IsOutlet IsRegulated
HypeXobs data frames	HypeXobs
Functions to Manipulate HYPE Info Files	AddInfoLine InfoManipulation RemoveInfoLine
Map regional irrigation source connection as spatial lines	MapRegionalSources
Merge HypeGeoData object	merge merge.HypeGeoData
Merge two HYPE observation data frames	MergeObs
Merge two Xobs data frames	MergeXobs
Nash-Sutcliffe Efficiency	NSE.HypeSingleVar
Get optimized classes from an imported optpar.txt file	OptimisedClasses OptimizedClasses
Find Outlet IDs	OutletIds
Find outlet-near observations in HYPE observation data files.	OutletNearObs
Find all Outlet SUBIDs of a model domain	OutletSubids
Create a Party Parrot.	PartyParrot
Percent bias	pbias.HypeSingleVar
Plot annual regimes	PlotAnnualRegime
Plot a suite of time series plots from a HYPE basin output file	PlotBasinOutput
Plot a summary of model results for a single sub-basin	PlotBasinSummary
Plot duration curves	PlotDurationCurve
Function for plotting up to two HYPE simulation results in maps.	PlotEvaluationMaps
Plot function for HYPE map results.	PlotMapOutput
Plot function for mapped point information	PlotMapPoints
Plot HYPE model parameter values.	PlotParValues
Plot model performance by SUBID attributes	PlotJohan PlotPerformanceByAttribute
Plot annual regimes of simulated and observed variables	PlotSimObsRegime
Plot HYPE model subbasin routing.	PlotSubbasinRouting
Pearson product-moment correlation coefficient r	r r.HypeSingleVar
Read a Basin Output File	ReadBasinOutput
Read a 'ClassData.txt' File	ReadClassData
Read a 'description.txt' file	ReadDescription
Read a 'GeoClass.txt' File	ReadGeoClass
Read a 'GeoData.txt' file	ReadGeoData
Read an 'info.txt' file	ReadInfo
Read a Map Output File	ReadMapOutput
Read HYPE observation data files	ReadObs ReadPTQobs
Read an 'optpar.txt' file	ReadOptpar
Read a 'par.txt' file	ReadPar
Read a 'pmsf.txt' file	ReadPmsf
Read a 'simass.txt' file	ReadSimass
Read a 'subassX.txt' file	ReadSubass
Read a Time Output File	ReadTimeOutput
Read optimization simulation results	ReadWsOutput
Read an 'Xobs.txt' file	ReadXobs
Re-scale SLC classes in a GeoData data frame	RescaleSLCClasses
Run HYPE model	RunHYPE
Scale 'AquiferData.txt' files to different model time steps	ScaleAquiferData
Scale 'FloodData.txt' files to different model time steps	ScaleFloodData
Scale 'par.txt' files to different model time step	ScalePar
HYPE Calibration Outputs to par.txt	AllSimToPar BestSimsToPar SimToPar
Sort a GeoData dataframe in downstream order	SortGeoData
Summarize subbasin attributes	SubidAttributeSummary
Calculate sums of SLC classes in a GeoData file	SumSLCClasses
Calculate upstream area sums	SumUpstreamArea
Calculate upstream sums and averages of selected GeoData contents	UpstreamGeoData
Calculate area-weighted upstream averages of grouped SLC class fractions.	UpstreamGroupSLCClasses
Summarize point source emissions of all upstream areas	UpstreamPointSources
Calculate SLC class fractions of all upstream areas	UpstreamSLCClasses
Lookup Functions For HYPE Variables	VariableInfo VariableLookup VariableSearch
Shiny App for visualizing HYPE MapOutputs.	VisualiseMapOutput VisualizeMapOutput
Shiny App for visualizing Mapped Point Information.	VisualiseMapPoints VisualizeMapPoints
Write a basin output '[SUBID].txt' file	WriteBasinOutput
Write a 'GeoClass.txt' file	WriteGeoClass
Write a 'GeoData.txt' file	WriteGeoData
Write a Harmonized Data File	WriteHarmonizedData
Write a Harmonized Spatial Description File	WriteHarmonizedSpatialDescription
Write a 'info.txt' File	WriteInfo
Write a 'mapXXXX.txt' file	WriteMapOutput
Write 'Pobs.txt', 'Tobs.txt', 'Qobs.txt', and other observation data files	WriteObs WritePTQobs
Write an 'optpar.txt' File	WriteOptpar
Write a 'par.txt' File	WritePar
Write a 'pmsf.txt' file	WritePmsf
Write a 'timeXXXX.txt' file	WriteTimeOutput
Write an 'Xobs.txt' File	WriteXobs

Package: HYPEtools 1.6.7

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

Analyze Catchment Area Characteristics

Analyze HYPE Time Series Outputs

Analyze Spatial Patterns

Basin Networks

Import HYPE Files

Modify a HYPE Parameter File

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)