plotly / plotly/plotly.py

Box plot with custom quartiles being inconsistent with upperfence parameter

Open
#3,558 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug P3
Dominant language
Python
Stars
18.8k
Forks
2.8k
Avg merge
16h 26m
Merged PRs (30d)
21

Description

In the documentation: https://plotly.com/python/box-plots/#box-plot-with-precomputed-quartiles

There is a code sample with upperfence parameter set to [5,6,7] which doesn't really make sense because the q3 values are [7,8,9] and I think the upperfence of a box plot can't be lower than the q3 values. However, the provided example returns a boxplot with all upperfences set to 9, which is the maximum-minimum upperfence value possible for the provided boxplots. I think this behavior is not desirable because difficult to understand.

I think it would be better to raise an error. If you prefer not to raise an error, I guess a better option would be to set the upperfence to the minimum possible values in each boxplot.

Have a nice day.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked documentation example, “Box plot with precomputed quartiles,” and trace how its q3 and upperfence values are handled. Compare the documented output with the requested behavior, then define and verify a consistent result for invalid upperfence values; the documentation example should no longer be confusing.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.