ceff-tech / ffc_api_client

An R client for the online Functional Flows Calculator API
https://ceff-tech.github.io/ffc_api_client
9 stars 3 forks source link

Add full metric name and units to plots for easy interpretation #53

Open kklausmeyer opened 4 years ago

kklausmeyer commented 4 years ago

The box plots are very helpful, but a little hard to interpret and share with stakeholders. Consider changing the name from the flow metric code to the flow metric name (e.g., "Fall Pulse Magnitude" instead of "FA_Mag"). Also, please consider adding the units for each plot (e.g, "Cubic Feet per Second" or "Water Year Day") to the y-axis of each plot. I have attached a file that provides the name and units for each metric code. Functional Flow Metrics List and Definitions.xlsx

nickrsan commented 4 years ago

Awesome - thanks Kirk! Good ideas. While you're here, can I point you to this issue https://github.com/ceff-tech/ffc_api_client/issues/48 - the Spring Duration component coming out of your API is being labeled SP_Du instead of SP_Dur - I've been meaning to get in touch about it.

kklausmeyer commented 4 years ago

Great! Thanks so much for putting this together. I was able to get it running on my computer and the results make sense. I'll pass on the naming issue to our developer Falk to see if he can update the API.