Add string option for metrics #504
Conversation
|
Do you have other examples than the peak ratio, where it would be relevant with additional output? |
Our "old" matlab repo included percentages relative to the observations mean, and a statement that SI is unbiased, e.g. here is a full example, taken from the Matlab equivalent: |
|
I agree that the (unbiased) str is another good example. but yeah not trying to butcher that plot, I think that the idea behind it is still worthy, and there could be more applications that we do not know yet |
|
But maybe it belongs more generally to the SkillTable than just the skill table next to the scatter plot... ? |
The percentages are relative to the observation mean. I do not care that much for them, but can be useful still.
That is the longer (and better) option, but it will likely require some like an auxiliary metrics class / attribute. I'm not 100% what the solution would look like. If you think this is work pursuing we can look into it. |
| fmt = f".{precision}f" | ||
| fvalue = f"{rounded_value:{fmt}}" | ||
| else: | ||
| fvalue = str(value) |
There was a problem hiding this comment.
How would this work then, if I have a skill called for instance PR and the value is 1.17, how would you add the text on the right as you did in your example picture ?
There was a problem hiding this comment.
The metric output is
str = f"{pr:.2f} (N={n_joint}"
An idea for 'special metrics':
The concept is that metrics can also produce string outputs. The main purpose for this is to add auxiliary info to the metrics, e.g. for Peak Ratios we often would like to know how many peaks there were:
While not currently used in modelskill itself, but applications using modelskill.
The downside is once the value is set, rounding of numbers would be tricky... But I don't know of any alternative (quick) solution to provide auxiliary metrics without breaking everything.