add vignette on group-aware and -wise behavior #453
Conversation
| @@ -0,0 +1,172 @@ | |||
| --- | |||
| title: "Grouping behavior in yardstick" | |||
There was a problem hiding this comment.
I had originally thought maybe this vignette would be called "Group-wise metrics" but it ended up being a bit more general than that.
There was a problem hiding this comment.
with a title like that, we might wanna preface a little earlier that this isn't about grouped data sets
There was a problem hiding this comment.
with a title like the one currently suggested or the previous "Group-wise metrics"? and in some ways, this is indeed about grouped data.
There was a problem hiding this comment.
i get worried, and confused myself a little bit, when we have this new methods, that share close names with group_by() related stuff.
I was thinking of having a "when we say X we talk about ABC, and when we say Y we talk about XYZ"
| * The `name` argument gives the name of the new metric we've created; we'll call ours "accuracy difference." | ||
| * The `aggregate` argument is a function defining how to go from `fn` output by group to a single numeric. | ||
|
|
||
| The output, `accuracy_diff`, is a function subclass called a `metric_factory`: |
There was a problem hiding this comment.
Trying to talk about functions as objects while adhering to tidyverse style is a bit difficult here. I'm game for however yall want to approach this. :)
Co-authored-by: Emil Hvitfeldt <[email protected]>
|
Much appreciated! Accepted all suggestions. |
Co-authored-by: Julia Silge <[email protected]>
|
On board for all of your changes, thank you @juliasilge! Ah, no, that's super important to get right! I'm all for transitioning from "group-wise" to "groupwise". Any thoughts on whether we should then write "group aware" instead of "group-aware"? |
|
Seems like "group-aware" is more common, like this. |
|
Awesome, we'll keep that, then. After putting 9145ba1 together, I do also appreciate that the way we write "groupwise" in text aligns with how it appears in code. :) Thanks again.🐙 |
|
This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue. |
Related to #434.