# Hydrologic Model Evaluation and Time-Series Tools

## Documentation for package ‘HyMETT’ version 1.1.2

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

## Help Pages

HyMETT-package | Hydrologic Model Evaluation and Time-series Tools
benchmark_KGE_DOY | Calculate benchmark Kling-Gupta efficiency (KGE) values from day-of-year (DOY) observations
calc_annual_flow_stats | Calculate annual flow statistics from daily data
calc_annual_stat_trend | Calculate trend in annual statistics
calc_logistic_regression | Calculate logistic regression in annual statistics with zero values
calc_qlpearsonIII | Quantile of Pearson Type III distribution for log-transformed data
calc_qpearsonIII | Quantile of Pearson Type III distribution
censor_values | Censor values above or below a threshold
example_annual | Example Annual Observations
example_mod | Example Model Output
example_mod_zf | Example Model Output with zero flows
example_obs | Example Observations
example_obs_zf | Example Observations with zero flows
example_preproc | Example Observations prepocessed
GOF_correlation_tests | Calculates Kendall's Tau, Spearman's Rho, Pearson Correlation
GOF_kling_gupta_efficiency | Calculate Kling-Gupta Efficiency (KGE)
GOF_mean_absolute_error | Calculates mean absolute error (MAE).
GOF_mean_error | Calculates mean error.
GOF_nash_sutcliffe_efficiency | Calculate Nash-Sutcliffe Efficiency (NSE)
GOF_percent_bias | Calculates percent bias.
GOF_rmse | Calculate root-mean-square error with options to normalize
GOF_summary | Calculate Goodness-of-fit metrics and output into table
GOF_volumetric_efficiency | Calculate Volumetric Efficiency
HyMETT | Hydrologic Model Evaluation and Time-series Tools
POR_apply_annual_hiflow_stats | Calculate the 50th and 90th percentiles of a streamflow time series
POR_apply_annual_lowflow_stats | Calculate 10-year and 2-year return periods of a streamflow time series
POR_calc_amp_and_phase | Calculate the seasonal amplitude and phase of a daily time series
POR_calc_AR1 | calculates lag-one autocorrelation (AR1) coefficient for a time series
POR_calc_lp3_quantile | Calculate quantile from fitted log-Pearson type III distribution
POR_deseasonalize | Removes seasonal trends from a daily or monthly time series.
POR_distribution_metrics | Calculates various metrics that describe the distribution of a time series of streamflow
preproc_audit_data | Audit daily data for total days in year
preproc_fill_daily | Fills daily data with missing dates as 'NA' values
preproc_main | A wrapper function for preproc_precondition_data, preproc_audit_data, and calc_annual_flow_stats
preproc_precondition_data | Pre-conditions data with time information and n-day moving averages
preproc_validate_daily | Validates that daily data do not contain gaps