Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the across argument in summarise_scores() #822

Closed
nikosbosse opened this issue May 19, 2024 · 2 comments · Fixed by #831
Closed

Remove the across argument in summarise_scores() #822

nikosbosse opened this issue May 19, 2024 · 2 comments · Fixed by #831
Labels
Breaking change This issue discusses or suggests a potentially breaking change

Comments

@nikosbosse
Copy link
Contributor

nikosbosse commented May 19, 2024

As discussed in #791: should we remove the across argument in summarise_scores()?

The idea is to be more opiniated about the happy path that users should take.

image

From #791:

For example, in summarize_score(), the by and across arguments are redundant, which is confusing for the user, and forces the developers to jump through extra input checking hoops. Since the transformation of one to the other, I would recommend being more opinionated, and having a single, well-documented option.

I guess democracy has spoken 🥲

@nikosbosse nikosbosse added the Breaking change This issue discusses or suggests a potentially breaking change label May 19, 2024
@nikosbosse nikosbosse added this to the scoringutils-2.0 milestone May 19, 2024
@nikosbosse nikosbosse changed the title Decide on whether to keep the across argument in summarise_scores() Remove the across argument in summarise_scores() May 19, 2024
@seabbs
Copy link
Contributor

seabbs commented May 19, 2024

This was something you really liked @nikosbosse and if that is the case I think you can push back on knowing the work better than us.

The alternative I see is creating a little function that maps the current across input into something that works in by but that might be a bit tricky

@nikosbosse
Copy link
Contributor Author

I liked it, but I guess sometimes you need to kill your darlings 🤷.

image

Surprisingly, I haven't used it that much as I expected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking change This issue discusses or suggests a potentially breaking change
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants