Inconsistent row and col parameters used to add vline to faceted subplots
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 18.8k
- フォーク
- 2.8k
- 平均マージ
- 16時間 26分
- マージ済み PR(30日)
- 21
説明
I'm trying to have a vertical line added to faceted plots, with the line being at a different position for every subplot. Here's a MRE:
import plotly.express as px
import pandas as pd
import numpy as np
from itertools import product
# Prepare data
combinations = list(product(range(1, 11), repeat=2))
df = pd.DataFrame(combinations, columns=['cat', 'x'])
df['y'] = np.random.randint(1, 100, size=len(df))
# Figure
fig = px.line(df, x='x', y='y', facet_col='cat', facet_col_wrap=3)
# Add vlines in a loop
def generate_lines(n, d):
tuples_list = []
a = 1 # Initial value for a
b = 1 # Initial value for b
for i in range(1, n+1):
tuples_list.append((i, a, b))
if i % d == 0: # Check if the divider is reached
a += 1 # Increment a when the divider is reached
b = 1 # Reset b to 1 when the divider is reached
else:
b += 1 # Increment b otherwise
return tuples_list
lines = generate_lines(10, 3)
for i, a, b in lines:
fig.add_vline(x=i, row=a, col=b, opacity=1, line_width=2, line_dash='dash', line_color='red')
fig.show()
What this code should produce is a vertical line at the value of the cat parameter but this is obviously not the case:
It took me a while to figure out what's actually happening. The issue is that the row argument does not start at the top left in the same way as faceting does, but instead starts at the bottom left. As a result, the (1,2) plot with a value of 2 is not shown because that's an empty space (would correspond to cat=11) and the 2nd subplot does not receive their vertical line.
This leads to inconsistencies and the required code to make the location more complicated because e.g. reducing the number of categories to 9 would mean that (1,1) needs to suddenly get a value of 7.
The behavior would be more intuitive if row 1 was the top one instead of the bottom one. If this is not a bug but a feature, it would be good to have this explicitly stated in the documentation / API reference.
Using plotly 5.13.0
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、提供された MRE を plotly 5.13.0 で再現し、facet_col_wrap がサブプロットの行をどのように割り当てるか、また add_vline が row と col をどのように解釈するかに注目してください。これらの API で公開されている facet とサブプロットの行/列の挙動を調査してください。行番号が faceting のレイアウトと一致するか、またはドキュメント/API リファレンスで既存の挙動とその workaround が明確に説明されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- data-visualization
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100