Improve handling of percentages for plot_counts #24
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As pointed out in #17, its behavior is somewhat confusing: > plot_percentages seemed to only just add a percentage sign on to the end of the number of respondents rather than convert the number of responses to percentages As a first step towards fixing that problem, this commit gives the argument a (hopefully) more descriptive name.
In this second part of the fix for #17, a new more intuitive behavior is introduced: given a set of pre-computed counts, setting the `compute_percentages` option will re-calculate the counts as percentages, and display the plot accordingly.
and deprecate `likert_percentages` Commit 45e992a added a new `compute_percentages` argument that allows aggregation of response counts into percentages. The current commit adds a warning, like the one we already had for the `plot_likert` function, if the counts vary between questions (making percentages misleading). With this change, the new argument can be used instead of the `likert_percentages` function, so that function is now deprecated. While it's supposed to be internal, I'm keeping it around in case anyone was using it directly.
I changed my mind about its necessity: people who still need this behavior can keep using `plot_percentage` (but face the deprecation warning), whereas new users should be encouraged to use `compute_percentages`, since its aggregation is harmless for fully precomputed percentages.
nmalkin
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #17 pointed out an awkwardness in the behavior of the
plot_countsfunction:As I wrote at the time:
To address this issue, the commits that are part of this PR make the following changes to the
plot_countsfunction:plot_percentageparameter with a warning (but keep it around for backwards compatibility)compute_percentagesthat converts the count to percentagesNote that these changes only affect
plot_counts.plot_likert.plot_likert, which is the primary entry point of this library, has not changed.