Detect and Characterize Sub-Daily Flow Fluctuations


[Up] [Top]

Documentation for package ‘hydropeak’ version 0.1.3

Help Pages

all_metrics Event Based Fluctuation Flow Parameters
amp AMP - Amplitude (Metric 1)
dur DUR - Duration (Metric 4)
durmid DUR_mid - Duration until midpoint (Metric 4.5)
Events Events
event_type Event Type
flow 'flow' S3 Class for Flow Rate Time Series
get_events Flow Fluctuation Events and Metrics
get_events_dir Flow Fluctuation Events and Metrics from Input Directory
get_events_file Flow Fluctuation Events and Metrics from Input File
mafr MAFR - Maximum Flow Fluctuation Rate (Metric 2)
maxfr MAX - Maximum Flow Rate (Metric 6)
mefr MEFR - Mean Flow Fluctuation Rate (Metric 3)
mefr1 MEFR_half1 - Mean Flow Fluctuation Rate of the first half (Metric 11)
mefr2 MEFR_half2 - Mean Flow Fluctuation Rate of the second half (Metric 12)
minfr MIN - Minimum Flow Rate (Metric 7)
Q Flow Fluctuations Q
qfrom Q_from - Starting flow rate (Metric 8)
qmid Q_mid - Average flow rate (Metric 10)
qto Q_to - Final flow rate (Metric 9)
ratio RATIO - Flow Ratio (Metric 5)
validate_flow 'flow' S3 Class for Flow Rate Time Series