DHI
Timeseries plot style
An update to the comparer plotter such that it takes a style and a color input. I wanted to also allow for color input, since this is actually the main reason why I started the issue #463: I want to use my own colors to match my other plots. The style input is just a bonus from my point of view :)
Design decisions:
- The user can only pass one of the two; either color OR style
- If none are passed, the default colors are used.
- Inputs can be passed as list of strings or as a single string. If a single string is passed but more than one model result is in the comparer, an error is raised. If len(list) < num_models an error is also raised.
- If len(color) > num_models: the first color is used for the observations. I am unsure whether this is the best way to do it, since there might be cases, where I just have a large list of colors that I pass to all of my plots regardless of the number of models... On the other hand, allowing the user to choose the observation colors is also useful in case of duplicate colors (default obs color is black, and maybe I want one of the lines to be black too?)
Example 1: giving a color input
# Given a comparer:
cmp = create_comparer()
# Pass a color input to the plot.timeseries() method
ax = cmp.plot.timeseries(color=["red", "blue"])
plt.show()
This code yields the following plot:
Example 2: also specifying the color of the observation points Above, the default color of the observations is black. If we want them to be e.g. green instead, we pass it as the first color.
# Pass a color input to the plot.timeseries() method
ax = cmp.plot.timeseries(color=["green","red", "blue"])
plt.show()
This yields the following plot:
Example 3: giving a style input We can also pass a style input instead
# Pass a color input to the plot.timeseries() method
ax = cmp.plot.timeseries(style=["r-.", "b--"])
plt.show()
@FrejaTerpPetersen for the benefit of the interested reader... could you please include some sample code and screenshots of the new functionality in this description above. Visuals are easy to grasp, when browsing around.
@ecomodeller I think it is ready for merge, unless you have further comments.
I updated according to Jespers comments:
- please change _check_kwarg_and_convert_to_list to only check for either style or color and rename to _check_arg_length_match_nmodels(arg, arg_name, n_mod) or to something with _parse (as it returns the same argument again) ->I changed the function to your first suggestion. Not familiar with '_parse' - what would that mean?
- move the function out of _misc.py and to top of _comparer_plotter.py (it is only used in this module) ->Done
- I think we should allow either lengths n_mod and n_mod+1 only (i.e. also issue exception if length is too long) -> Hmmm, my reason for allowing more colors is that the user of the function might just have some generic list of colors from a theme that they want to input without subsetting. But maybe that is an unusual use-case?
- I guess the style and color arguments only applied to matplotlib backend and not plotly. If that is the case - it should be clear in the docstring. Better: add it to plotly backend also. -> I changed docstring - not familiar with plotly so can't quickly do this.
- currently all kwargs are accepted, e.g. cmp.plot.timeseries(assdsddsdas="Reds") does not give me an error message. It should. It is not strictly part of this PR, but as this function is now "open", we should fix it. -> Hmm, not sure I understand exactly ...
@ecomodeller, @jsmariegaard - do you want to review before merging?
Hi.
Unrelated (or not?) question, but does this apply to, eg the QQ-plot? (which is more like a scatter plot but just with QQ data).
as in, can I do cmp.plot.qq(color=['r','b']) or will it not work?
I know that the title of the PR says timeseries, but just asking.
