Learn R Programming

HyMETT (version 1.1.3)

Hydrologic Model Evaluation and Time-Series Tools

Description

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.

Copy Link

Version

Install

install.packages('HyMETT')

Monthly Downloads

172

Version

1.1.3

License

CC0

Maintainer

Colin Penn

Last Published

August 28th, 2024

Functions in HyMETT (1.1.3)

GOF_summary

Calculate Goodness-of-fit metrics and output into table
POR_calc_lp3_quantile

Calculate quantile from fitted log-Pearson type III distribution
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
GOF_volumetric_efficiency

Calculate Volumetric Efficiency
GOF_percent_bias

Calculates percent bias.
POR_distribution_metrics

Calculates various metrics that describe the distribution of a time series of streamflow
benchmark_KGE_DOY

Calculate benchmark Kling--Gupta efficiency (KGE) values from day-of-year (DOY) observations
calc_logistic_regression

Calculate logistic regression in annual statistics with zero values
GOF_mean_absolute_error

Calculates mean absolute error (MAE).
example_mod_zf

Example Model Output with zero flows
HyMETT-package

Hydrologic Model Evaluation and Time-series Tools
GOF_rmse

Calculate root-mean-square error with options to normalize
calc_qlpearsonIII

Quantile of Pearson Type III distribution for log-transformed data
POR_calc_AR1

calculates lag-one autocorrelation (AR1) coefficient for a time series
GOF_mean_error

Calculates mean error.
calc_annual_flow_stats

Calculate annual flow statistics from daily data
preproc_main

A wrapper function for preproc_precondition_data, preproc_audit_data, and calc_annual_flow_stats
POR_calc_amp_and_phase

Calculate the seasonal amplitude and phase of a daily time series
example_obs

Example Observations
preproc_validate_daily

Validates that daily data do not contain gaps
calc_annual_stat_trend

Calculate trend in annual statistics
POR_deseasonalize

Removes seasonal trends from a daily or monthly time series.
example_obs_zf

Example Observations with zero flows
example_preproc

Example Observations prepocessed
calc_qpearsonIII

Quantile of Pearson Type III distribution
censor_values

Censor values above or below a threshold
example_annual

Example Annual Observations
preproc_audit_data

Audit daily data for total days in year
preproc_fill_daily

Fills daily data with missing dates as NA values
example_mod

Example Model Output
preproc_precondition_data

Pre-conditions data with time information and n-day moving averages
GOF_correlation_tests

Calculates Kendall's Tau, Spearman's Rho, Pearson Correlation
GOF_nash_sutcliffe_efficiency

Calculate Nash--Sutcliffe Efficiency (NSE)
GOF_kling_gupta_efficiency

Calculate Kling--Gupta Efficiency (KGE)