-
Notifications
You must be signed in to change notification settings - Fork 199
Add whisker customization documentation for ggbetweenstats #1010
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
base: main
Are you sure you want to change the base?
Conversation
@IndrajeetPatil 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: IndrajeetPatil <11330453+IndrajeetPatil@users.noreply.github.com>
ggbetweenstats
?
@copilot Please address the review feedback |
…able and example Co-authored-by: IndrajeetPatil <11330453+IndrajeetPatil@users.noreply.github.com>
Co-authored-by: IndrajeetPatil <11330453+IndrajeetPatil@users.noreply.github.com>
This PR addresses the user request to modify the whisker portion of
ggbetweenstats()
and clarify what the whiskers represent. Previously, users had no documented way to customize whisker behavior, and it was unclear that whiskers show 1.5 × IQR by default.Key Changes
Enhanced Documentation: Updated
boxplot.args
parameter documentation to clearly explain that whiskers extend to 1.5 times the interquartile range (IQR) by default, following the Tukey method. Added explicit guidance on using thecoef
parameter for customization.Comprehensive FAQ Entry: Added FAQ #30 "How to modify the whiskers in box plots from ggbetweenstats?" with multiple examples covering different whisker scenarios including data range only (
coef = 0
) and custom multipliers.Technical Approach
The functionality was already available through the existing
exec(geom_boxplot, !!!boxplot.args, outlier.shape = NA)
implementation, which passes allboxplot.args
toggplot2::geom_boxplot()
. Sincegeom_boxplot()
accepts acoef
parameter to control whisker length, users can now access this through documented usage ofboxplot.args = list(coef = value)
.This solution maintains full backward compatibility while making previously hidden functionality discoverable and usable.
Fixes #912.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.