plotly.js icon indicating copy to clipboard operation
plotly.js copied to clipboard

Boxplot: Set Whisker options

Open jdittrich opened this issue 9 years ago • 13 comments

Problem: Boxplot Whiskers can map to different data – sometimes this is +- 1.5 times the interquartil range, sometime the 5th and 95th percentile etc. In the box documentation, it is state that plotly uses the +-1.5 IQR as a standard. It is also stated that the boxpoints option allows other options, but seemingly boxpoints sets the displaying sof catterpoint and not of whiskers.

Proposed Solution: An option for setting what the whiskers mean. Candidates for this option would:

  • n * IQR (for a +-1.5* the IQR, like the current default)
  • nth percentiles (for something like a 5%/95% position)
  • n*sd (for a +- 1 standard deviation position)

Or, if that option(s) already exists, a hint in the docuementation on how to set them.

jdittrich avatar Feb 24 '16 08:02 jdittrich

Thanks for the very clear description :beers:

You are correct. There is no way to override the box trace whisker metric at the moment.

Adding whiskers option is a great suggestion!

Unfortunately, because of other obligations, no plotly.js team member will dedicate time to this enhancement until at least April 1st.

That said, this issue could be a great way for someone from the community to make a PR. All the action will take place in src/traces/box/ starting by adding a trace attribute in src/traces/box/attributes.js then coercing it in the default step src/traces/box/defaults.js and finally generalizing the calc step in src/traces/box/calc.js.

etpinard avatar Feb 24 '16 14:02 etpinard

:beers: cheers! Thanks for pointing out the relevant files. I see what I can do but can't promise that I'm quicker than April the 1st :-)

jdittrich avatar Feb 28 '16 19:02 jdittrich

@etpinard @jdittrich is this still unresolved?

alanocallaghan avatar Jun 12 '17 19:06 alanocallaghan

@Alanocallaghan sadly not, I was unable to tackle it.

jdittrich avatar Jun 13 '17 15:06 jdittrich

see also #1953 - one of the options should be max/min (which I guess would count as 0/100th percentile?) - and then rather than the current hard-coded dependence on boxpoints, boxpoints should just affect the default value of this setting.

alexcjohnson avatar Aug 15 '17 22:08 alexcjohnson

Any updates on this in 2019? Having the whiskers mean one thing in some graphs (where the boxpoints are visible) and another in others (where the boxpoints are not visible) is somewhat confusing.

FelixZY avatar May 15 '19 12:05 FelixZY

Agreed. Whiskers should correspond to editable percentile. That's how matplotlib does it.

diegoscarabelli avatar Jan 16 '20 22:01 diegoscarabelli

Any update on this issue?

FilipVel avatar Jul 07 '20 09:07 FilipVel

Seems like an old issue but keeps on coming back. I was a bit thrown off when I set boxpoints=False but suddenly my whiskers extended to cover all the outliers and the entire plot changed. This is for plotly.py.

Screenshot from 2020-07-13 20-14-07

ahmedhosny avatar Jul 14 '20 00:07 ahmedhosny

This issue has been tagged with NEEDS SPON$OR

A community PR for this feature would certainly be welcome, but our experience is deeper features like this are difficult to complete without the Plotly maintainers leading the effort.

What Sponsorship includes:

  • Completion of this feature to the Sponsor's satisfaction, in a manner coherent with the rest of the Plotly.js library and API
  • Tests for this feature
  • Long-term support (continued support of this feature in the latest version of Plotly.js)
  • Documentation at plotly.com/javascript
  • Possibility of integrating this feature with Plotly Graphing Libraries (Python, R, F#, Julia, MATLAB, etc)
  • Possibility of integrating this feature with Dash
  • Feature announcement on community.plotly.com with shout out to Sponsor (or can remain anonymous)
  • Gratification of advancing the world's most downloaded, interactive scientific graphing libraries (>50M downloads across supported languages)

Please include the link to this issue when contacting us to discuss.

jackparmer avatar Sep 10 '20 19:09 jackparmer

Hi - this issue has been sitting for a while, so as part of our effort to tidy up our public repositories I'm going to close it. If it's still a concern, we'd be grateful if you could open a new issue (with a short reproducible example if appropriate) so that we can add it to our stack. Cheers - @gvwilson

gvwilson avatar Jun 05 '24 12:06 gvwilson

Is there any open issue still tracking this feature? This has been bugging me for years, working from the Python side.

For reference, there is a workaround to have the normal IQR whiskers while not having boxpoints shown: marker: {opacity: 0}

rabyj avatar Apr 24 '25 21:04 rabyj

there isn't, but I'll reopen this one - we're unlikely to get to it any time soon, but we'd be happy to prioritize review of a community PR. thanks - @gvwilson

gvwilson avatar Apr 25 '25 12:04 gvwilson