All functions

FFCProcessor

FFCProcessor Class

USGSGage

USGS Gage Retrieval Tools

assess_alteration()

Assess hydrologic alteration by flow metric

attach_water_year_data()

Add calendar_year/calendar_month/calendar_day/water_year fields

clean_account()

Clean account

early_or_late()

Determine if timing metrics are early, late, or in range

evaluate_alteration()

Generate FFC Results and Plots for Timeseries Data

evaluate_gage_alteration()

Generate FFC Results and Plots for Gage Data

ffcAPIClient

ffcAPIClient: Processes time-series flow data using the online functional flows calculator

fill_na_10th_percentile()

Fill 10th Percentile NA values when 25th percentile value is 0

filter_timeseries()

Filter Timeseries data

flow_metrics

Modeled flow metric predictions for all stream segments

force_consistent_naming()

Set Preference to Rename Metrics Consistently

gage_comids

Where we know the lat/long will produce the wrong COMID for a gage (such as giving us a nearby tributary and not the mainstem, or vice versa), we can hardcode their COMIDs here to make sure we get the correct location. We haven't looked through all gages to make sure every one is correct, but as we find them, this will help improve results and reduce error

get_comid_for_lon_lat()

Retrieves COMID for a given USGS gage which collects daily data.

get_drh()

Returns the dimensionless reference hydrograph results as a data frame

get_ffc_parameters_for_comid()

Get the parameters sent to the FFC for a stream segment

get_ffc_results_for_usgs_gage()

Run Gage Data Through the Functional Flows Calculator

get_predicted_flow_metrics()

Retrieves flow predicted flow metric values for a stream segment

get_results_as_df()

Convert FFC results list to data frame with metric names

get_token()

Retrieve Previously Set Token

get_usgs_gage_data()

Retrieves USGS timeseries gage data

merge_list()

Merges Data Frames by Year Column

plot_drh()

Plots the Dimensionless Reference Hydrograph

set_token()

Set Eflows Website Access Token

stream_class_data

Geomorphic Stream Classification