add align argument to compare()

[gdementen]

Our users often compare variants but also old runs for their models which do not have the same axes (especially time range) than the current model results.

See larray-project/larray#501
Note that larray-project/larray#463 would bring that for free.

[gdementen]

• This should work for both comparing sessions or arrays.
• This should be optional (with either an argument align=XYZ, or check_axes=XYZ to check the axes are the same (which is essentially the same thing). I am totally unsure which should be the default though:
  • some users use compare to check whether the axes are the same and if so check the differences, so would be annoyed by a change in behavior.
  • some users align manually before comparing (or worse: do not use compare because it is too cumbersome to do that), so would benefit from align by default.

@alixdamman: what do you think?

[alixdamman]

I find aligning arrays and sessions in compare() is really good idea.

This should work for both comparing sessions or arrays.

Indeed.

This should be optional (with either an argument align=XYZ, or check_axes=XYZ to check the axes are the same (which is essentially the same thing). I am totally unsure which should be the default though:
- some users use compare to check whether the axes are the same and if so check the differences, so would be annoyed by a change in behavior.
- some users align manually before comparing (or worse: do not use compare because it is too cumbersome to do that), so would benefit from align by default.

I would first add an argument align to the compare() function with possible values None, 'inner', 'outer', 'left' and 'right' + a ComboBox with the same choices in the compare() window.

The remaining question is what to choose as default value for the argument align (and so the ComboBox).
IMO, it should be 'outer'. In case of different labels, the corresponding values (nan) will appear as different indicationg there is a possible mismatch between labels. If the users are enough smart, they would be able to understand the problem because of the nan.
It is impossible to satisfy all users. To me, the more logical is to take 'outer' as default value as it is the most informative check the difference in values and labels).

Feel free to have your own opinion. You have mine.

[gdementen]

I would first add an argument align to the compare() function with possible values None, 'inner', 'outer', 'left' and 'right' + a ComboBox with the same choices in the compare() window.

I thought about making the argument a boolean but your idea is much better. And making a combo box for it is a good idea too... but I am unsure where to place the combobox, especially for the Session comparator. Will have to think about this. I think we could first implement the argument, then the combobox.

[alixdamman]

I think we could first implement the argument, then the combobox.

I agree.