Closed nikosbosse closed 7 months ago
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 95.27%. Comparing base (
0982955
) to head (004b1f3
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
plot_pairwise_comparisons()
For this little one shall we just chuck in an alias? It seems a bit cruel! Or shall we just be cruel?
Maybe we should just be cruel? I don't know, the downside to aliases that I see is that they clutter the docs and the autocomplete dropdown
Dear future user, if you're reading this and are upset: we apologise for our cruelty. Please blame it on me and only me.
I think the change is a bit annoying, but you're code is going to break anyways, regardless of whether we keep the s
or not. So we might as well break everything hard this time..
But happy to open an issue if we think it's useful.
Description
As discussed in #638, this PR
add_pairwise_comparison()
toadd_relative_skill()
pairwise_comparison()
toget_pairwise_comparisons()
plot_pairwise_comparison()
toplot_pairwise_comparisons()
which is a breaking change I'm sure people will love...The rationale for this change is this:
add_relative_skil()
is a bit more descriptive thanadd_pairwise_comparison()
in terms of what it doesget_pairwise_comparisons()
would make it clear that these are two different workflows with two different purposes (one mainly for plotting, the other for computing scores).get_pairwise_comparisons()
would make the naming of the function more in line with the otherget_
-functionsget_pairwise_comparisons()
rather thanget_relative_skill()
because the main thing this function is meant to give you according to our updated workflow is the (visualisation of) mean score ratios (see below)plot_pairwise_comparison()
toplot_pairwise_comparisons()
is a bit stupid. Butget_pairwise_comparisons()
feels more appropriate thanget_pairwise_comparison()
and theget_
and theplot_
function should be consistent. We could do aliases? Or stick with the singular after all.Visualisation of mean score ratios:
Checklist
lintr::lint_package()
to check for style issues introduced by my changes.