Package: HyMETT 1.1.3

HyMETT: Hydrologic Model Evaluation and Time-Series Tools

Facilitates the analysis and evaluation of hydrologic model output and time-series data with functions focused on comparison of modeled (simulated) and observed data, period-of-record statistics, and trends.

Authors:Colin Penn [aut, cre], Caelan Simeone [aut], Sara Levin [aut], Samuel Saxe [aut], Sydney Foks [aut], Robert Dudley [dtc], Glenn Hodgkins [dtc], Timothy Hodson [aut], Thomas Over [dtc], Amy Russell [dtc]

HyMETT_1.1.3.tar.gz
HyMETT_1.1.3.zip(r-4.5)HyMETT_1.1.3.zip(r-4.4)HyMETT_1.1.3.zip(r-4.3)
HyMETT_1.1.3.tgz(r-4.4-any)HyMETT_1.1.3.tgz(r-4.3-any)
HyMETT_1.1.3.tar.gz(r-4.5-noble)HyMETT_1.1.3.tar.gz(r-4.4-noble)
HyMETT_1.1.3.tgz(r-4.4-emscripten)HyMETT_1.1.3.tgz(r-4.3-emscripten)
HyMETT.pdf |HyMETT.html✨
HyMETT/json (API)
NEWS

# Install 'HyMETT' in R:
install.packages('HyMETT', repos = c('https://cpenn-usgs.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Datasets:

On CRAN:

This package does not link to any Github/Gitlab/R-forge repository. No issue tracker or development information is available.

28 exports 0.23 score 45 dependencies 177 downloads

Last updated 20 days agofrom:1fe5a71f3c. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKAug 29 2024
R-4.5-winOKAug 29 2024
R-4.5-linuxOKAug 29 2024
R-4.4-winOKAug 29 2024
R-4.4-macOKAug 29 2024
R-4.3-winOKAug 29 2024
R-4.3-macOKAug 29 2024

Exports:benchmark_KGE_DOYcalc_annual_flow_statscalc_annual_stat_trendcalc_logistic_regressioncalc_qlpearsonIIIcalc_qpearsonIIIcensor_valuesGOF_correlation_testsGOF_kling_gupta_efficiencyGOF_mean_absolute_errorGOF_mean_errorGOF_nash_sutcliffe_efficiencyGOF_percent_biasGOF_rmseGOF_summaryGOF_volumetric_efficiencyPOR_apply_annual_hiflow_statsPOR_apply_annual_lowflow_statsPOR_calc_amp_and_phasePOR_calc_AR1POR_calc_lp3_quantilePOR_deseasonalizePOR_distribution_metricspreproc_audit_datapreproc_fill_dailypreproc_mainpreproc_precondition_datapreproc_validate_daily

Dependencies:backportscheckmateclicolorspacecpp11dplyrEnvStatsfansifarvergenericsggplot2gluegoftestgtableisobandlabelinglatticelifecyclelmomcoLmomentslubridatemagrittrMASSMatrixmgcvmunsellnlmenortestpillarpkgconfigplyrR6RColorBrewerRcppRcppArmadillorlangscalestibbletidyselecttimechangeutf8vctrsviridisLitewithrzoo

Basic workflow of HyMETT

Colin Penn and Caelen Simeone

Rendered fromHyMETT_Basic_Workflow.Rmdusingknitr::rmarkdownon Aug 29 2024.

Last update: 2023-11-23
Started: 2023-11-23

Readme and manuals

Help Manual

Help pageTopics
Hydrologic Model Evaluation and Time-series ToolsHyMETT-package HyMETT _PACKAGE
Calculate benchmark Kling-Gupta efficiency (KGE) values from day-of-year (DOY) observationsbenchmark_KGE_DOY
Calculate annual flow statistics from daily datacalc_annual_flow_stats
Calculate trend in annual statisticscalc_annual_stat_trend
Calculate logistic regression in annual statistics with zero valuescalc_logistic_regression
Quantile of Pearson Type III distribution for log-transformed datacalc_qlpearsonIII
Quantile of Pearson Type III distributioncalc_qpearsonIII
Censor values above or below a thresholdcensor_values
Example Annual Observationsexample_annual
Example Model Outputexample_mod
Example Model Output with zero flowsexample_mod_zf
Example Observationsexample_obs
Example Observations with zero flowsexample_obs_zf
Example Observations prepocessedexample_preproc
Calculates Kendall's Tau, Spearman's Rho, Pearson CorrelationGOF_correlation_tests
Calculate Kling-Gupta Efficiency (KGE)GOF_kling_gupta_efficiency
Calculates mean absolute error (MAE).GOF_mean_absolute_error
Calculates mean error.GOF_mean_error
Calculate Nash-Sutcliffe Efficiency (NSE)GOF_nash_sutcliffe_efficiency
Calculates percent bias.GOF_percent_bias
Calculate root-mean-square error with options to normalizeGOF_rmse
Calculate Goodness-of-fit metrics and output into tableGOF_summary
Calculate Volumetric EfficiencyGOF_volumetric_efficiency
Calculate the 50th and 90th percentiles of a streamflow time seriesPOR_apply_annual_hiflow_stats
Calculate 10-year and 2-year return periods of a streamflow time seriesPOR_apply_annual_lowflow_stats
Calculate the seasonal amplitude and phase of a daily time seriesPOR_calc_amp_and_phase
calculates lag-one autocorrelation (AR1) coefficient for a time seriesPOR_calc_AR1
Calculate quantile from fitted log-Pearson type III distributionPOR_calc_lp3_quantile
Removes seasonal trends from a daily or monthly time series.POR_deseasonalize
Calculates various metrics that describe the distribution of a time series of streamflowPOR_distribution_metrics
Audit daily data for total days in yearpreproc_audit_data
Fills daily data with missing dates as 'NA' valuespreproc_fill_daily
A wrapper function for preproc_precondition_data, preproc_audit_data, and calc_annual_flow_statspreproc_main
Pre-conditions data with time information and n-day moving averagespreproc_precondition_data
Validates that daily data do not contain gapspreproc_validate_daily