Package: HYPEtools 1.6.4.9000

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.4.9000.tar.gz
HYPEtools_1.6.4.9000.zip(r-4.5)HYPEtools_1.6.4.9000.zip(r-4.4)HYPEtools_1.6.4.9000.zip(r-4.3)
HYPEtools_1.6.4.9000.tgz(r-4.5-any)HYPEtools_1.6.4.9000.tgz(r-4.4-any)HYPEtools_1.6.4.9000.tgz(r-4.3-any)
HYPEtools_1.6.4.9000.tar.gz(r-4.5-noble)HYPEtools_1.6.4.9000.tar.gz(r-4.4-noble)
HYPEtools_1.6.4.9000.tgz(r-4.4-emscripten)HYPEtools_1.6.4.9000.tgz(r-4.3-emscripten)
HYPEtools.pdf |HYPEtools.html✨
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.54 score 17 stars 26 scripts 493 downloads 156 exports 79 dependencies

Last updated 11 hours agofrom:2722a58f39. Checks:8 OK. Indexed: yes.

TargetResultLatest binary
Doc / VignettesOKFeb 18 2025
R-4.5-winOKFeb 18 2025
R-4.5-macOKFeb 18 2025
R-4.5-linuxOKFeb 18 2025
R-4.4-winOKFeb 18 2025
R-4.4-macOKFeb 18 2025
R-4.3-winOKFeb 18 2025
R-4.3-macOKFeb 18 2025

Exports:AddInfoLineAllDownstreamSubidsAllSimToParAllUpstreamSubidsAnnualRegimeBarplotUpstreamClassesBestSimsToParBoxplotSLCClassesCleanSLCClassesColBluesColDiffGenericColDiffTempColGreensColNitrColPhosColPrecColPurplesColQColRedsColTempColYOBCompareFilesConvertDischargeCreateOptpardatetimedatetime<-DirectUpstreamSubidsdistinctColorPaletteEquallySpacedObsExtractFreqExtractStatsgofGroupSLCClassesGwRetentionHeadwaterSubidsHypeGeoDataHypeMultiVarHypeSingleVarhypeunithypeunit<-HypeXobsIsHeadwaterIsOutletIsRegulatedKGEmaeMapRegionalSourcesMergeObsMergeXobsNSEobsidobsid<-OptimisedClassesOptimizedClassesOutletIdsOutletNearObsOutletSubidsoutregidoutregid<-PartyParrotpbiasPlotAnnualRegimePlotBasinOutputPlotBasinSummaryPlotDurationCurvePlotJohanPlotMapOutputPlotMapPointsPlotPerformanceByAttributePlotSimObsRegimePlotSubbasinRoutingrReadAllsimReadAquiferDataReadBasinOutputReadBranchDataReadClassDataReadCropDataReadDamDataReadDescriptionReadFloodDataReadForcKeyReadGeoClassReadGeoDataReadGlacierDataReadInfoReadLakeDataReadMapOutputReadMgmtDataReadObsReadOptparReadOutregionsReadParReadPmsfReadPointSourceDataReadPTQobsReadSimassReadSubassReadTimeOutputReadUpdateReadWsOutputReadXobsRemoveInfoLineRescaleSLCClassesrPearsonScaleAquiferDataScaleFloodDataScaleParsKGESortGeoDatasubidsubid<-SubidAttributeSummarySumSLCClassesSumUpstreamAreatimesteptimestep<-UpstreamGeoDataUpstreamGroupSLCClassesUpstreamPointSourcesUpstreamSLCClassesvalindexvariablevariable<-VariableInfoVariableSearchVEVisualiseMapOutputVisualiseMapPointsVisualizeMapOutputVisualizeMapPointsWriteAquiferDataWriteBasinOutputWriteBranchDataWriteCropDataWriteDamDataWriteFloodDataWriteForcKeyWriteGeoClassWriteGeoDataWriteGlacierDataWriteHarmonizedDataWriteHarmonizedSpatialDescriptionWriteInfoWriteLakeDataWriteMapOutputWriteMgmtDataWriteObsWriteOptparWriteOutregionsWriteParWritePmsfWritePointSourceDataWritePTQobsWriteTimeOutputWriteXobs

Dependencies:abindbackportsbootbroomcarcarDataclicliprcolorspacecorrplotcowplotcpp11data.tableDerivdoBydplyrfansifarverFormulagenericsggplot2ggpubrggrepelggsciggsignifgluegridExtragtableisobandlabelinglatticelifecyclelme4lubridatemagrittrMASSMatrixMatrixModelsmgcvmicrobenchmarkminqamodelrmunsellncdf4nlmenloptrnnetnumDerivpatchworkpbapplypbkrtestpillarpkgconfigpolynompurrrquantregR6rbibutilsRColorBrewerRcppRcppEigenRdpackreformulasrlangrstatixscalesSparseMstringistringrsurvivaltibbletidyrtidyselecttimechangeutf8vctrsviridisLitewithrzoo

Analyze Catchment Area Characteristics

Rendered frombasin_characteristics.Rmdusingknitr::rmarkdownon Feb 18 2025.

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

Analyze HYPE Time Series Outputs

Rendered fromanalyze_hype_ts.Rmdusingknitr::rmarkdownon Feb 18 2025.

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

Analyze Spatial Patterns

Rendered fromplot_map_statistics.Rmdusingknitr::rmarkdownon Feb 18 2025.

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

Basin Networks

Rendered frombasin_network.Rmdusingknitr::rmarkdownon Feb 18 2025.

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

Import HYPE Files

Rendered fromimport_files.Rmdusingknitr::rmarkdownon Feb 18 2025.

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

Modify a HYPE Parameter File

Rendered frommodify_par.Rmdusingknitr::rmarkdownon Feb 18 2025.

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

Readme and manuals

Help Manual

Help pageTopics
Find All Downstream SUBIDsAllDownstreamSubids
Find All Upstream SUBIDsAllUpstreamSubids
Calculate annual regimesAnnualRegime
Bar plots of upstream-averaged classes of HYPE sub-basinsBarplotUpstreamClasses
Box plots of SLC distributionsBoxplotSLCClasses
Clean Soil-Landuse classes (SLCs) from small fractionsCleanSLCClasses
Compare HYPE model files to identify any differences.CompareFiles
Calculate Specific runoff from volumetric discharge and vice versaConvertDischarge
Create an optpar listCreateOptpar
Custom color ramp palettesColBlues ColDiffGeneric ColDiffTemp ColGreens ColNitr ColPhos ColPrec ColPurples ColQ ColReds ColTemp ColYOB CustomColors
Find Direct Upstream SUBIDs, with Flow FractionsDirectUpstreamSubids
Generate optimally distinct color palettesdistinctColorPalette
Create an equally spaced time series from irregular observationsEquallySpacedObs
Extract quantiles for use in a frequency distribution plot, e.g. a flow duration curveExtractFreq
Extract statistics from time seriesExtractStats
Goodness of Fit FunctionsGOF 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 fileGroupSLCClasses
Calculate groundwater retention of nutrientsGwRetention
Find all headwater SUBIDs of a model domainHeadwaterSubids
Quickly query and set HYPE-specific attributesdatetime datetime<- HypeAttrAccess hypeunit hypeunit<- obsid obsid<- outregid outregid<- subid subid<- timestep timestep<- variable variable<-
Write HYPE data filesHypeDataExport WriteAquiferData WriteBranchData WriteCropData WriteDamData WriteFloodData WriteForcKey WriteGlacierData WriteLakeData WriteMgmtData WriteOutregions WritePointSourceData
Read HYPE data filesHypeDataImport ReadAllsim ReadAquiferData ReadBranchData ReadCropData ReadDamData ReadFloodData ReadForcKey ReadGlacierData ReadLakeData ReadMgmtData ReadOutregions ReadPointSourceData ReadUpdate
HypeGeoData data framesHypeGeoData
HypeMultiVar arraysHypeMultiVar
HypeSingleVar arraysHypeSingleVar
Check HYPE SUBID propertiesHypeSubidChecks IsHeadwater IsOutlet IsRegulated
HypeXobs data framesHypeXobs
Functions to Manipulate HYPE Info FilesAddInfoLine InfoManipulation RemoveInfoLine
Map regional irrigation source connection as spatial linesMapRegionalSources
Merge HypeGeoData objectmerge merge.HypeGeoData
Merge two HYPE observation data framesMergeObs
Merge two Xobs data framesMergeXobs
Nash-Sutcliffe EfficiencyNSE.HypeSingleVar
Get optimized classes from an imported optpar.txt fileOptimisedClasses OptimizedClasses
Find Outlet IDsOutletIds
Find outlet-near observations in HYPE observation data files.OutletNearObs
Find all Outlet SUBIDs of a model domainOutletSubids
Create a Party Parrot.PartyParrot
Percent biaspbias.HypeSingleVar
Plot annual regimesPlotAnnualRegime
Plot a suite of time series plots from a HYPE basin output filePlotBasinOutput
Plot a summary of model results for a single sub-basinPlotBasinSummary
Plot duration curvesPlotDurationCurve
Plot function for HYPE map results.PlotMapOutput
Plot function for mapped point informationPlotMapPoints
Plot model performance by SUBID attributesPlotJohan PlotPerformanceByAttribute
Plot annual regimes of simulated and observed variablesPlotSimObsRegime
Plot HYPE model subbasin routing.PlotSubbasinRouting
Pearson product-moment correlation coefficient rr r.HypeSingleVar
Read a Basin Output FileReadBasinOutput
Read a 'ClassData.txt' FileReadClassData
Read a 'description.txt' fileReadDescription
Read a 'GeoClass.txt' FileReadGeoClass
Read a 'GeoData.txt' fileReadGeoData
Read an 'info.txt' fileReadInfo
Read a Map Output FileReadMapOutput
Read HYPE observation data filesReadObs ReadPTQobs
Read an 'optpar.txt' fileReadOptpar
Read a 'par.txt' fileReadPar
Read a 'pmsf.txt' fileReadPmsf
Read a 'simass.txt' fileReadSimass
Read a 'subassX.txt' fileReadSubass
Read a Time Output FileReadTimeOutput
Read optimization simulation resultsReadWsOutput
Read an 'Xobs.txt' fileReadXobs
Re-scale SLC classes in a GeoData data frameRescaleSLCClasses
Scale 'AquiferData.txt' files to different model time stepsScaleAquiferData
Scale 'FloodData.txt' files to different model time stepsScaleFloodData
Scale 'par.txt' files to different model time stepScalePar
HYPE Calibration Outputs to par.txtAllSimToPar BestSimsToPar SimToPar
Sort a GeoData dataframe in downstream orderSortGeoData
Summarize subbasin attributesSubidAttributeSummary
Calculate sums of SLC classes in a GeoData fileSumSLCClasses
Calculate upstream area sumsSumUpstreamArea
Calculate upstream sums and averages of selected GeoData contentsUpstreamGeoData
Calculate area-weighted upstream averages of grouped SLC class fractions.UpstreamGroupSLCClasses
Summarize point source emissions of all upstream areasUpstreamPointSources
Calculate SLC class fractions of all upstream areasUpstreamSLCClasses
Lookup Functions For HYPE VariablesVariableInfo 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' fileWriteBasinOutput
Write a 'GeoClass.txt' fileWriteGeoClass
Write a 'GeoData.txt' fileWriteGeoData
Write a Harmonized Data FileWriteHarmonizedData
Write a Harmonized Spatial Description FileWriteHarmonizedSpatialDescription
Write a 'info.txt' FileWriteInfo
Write a 'mapXXXX.txt' fileWriteMapOutput
Write 'Pobs.txt', 'Tobs.txt', 'Qobs.txt', and other observation data filesWriteObs WritePTQobs
Write an 'optpar.txt' FileWriteOptpar
Write a 'par.txt' FileWritePar
Write a 'pmsf.txt' fileWritePmsf
Write a 'timeXXXX.txt' fileWriteTimeOutput
Write an 'Xobs.txt' FileWriteXobs