No support for .obsm keys as color source in render functions
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 68/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- python
調査の方向性
utils.py の _validate_col_for_column_table(2838–2872 行付近)から始め、_locate_value と render_shapes、render_labels、render_points の色解決パスを調べてください。最小限の例を使って、.obsm の DataFrame 値を obs にコピーせずに選択できることを確認し、選択したキー構文と結果の色についてのカバレッジを追加または更新してください。
索引モデルが issue の本文から書いたものです。
説明
No support for .obsm keys as color source in render functions
Environment: spatialdata-plot 0.3.4.dev (main, commit 5cfedc7), Python 3.13
Problem
render_shapes, render_labels, and render_points resolve color= from table.obs columns and table.var_names (gene expression), but they do not check table.obsm. Any per-cell metric stored in .obsm — spatial QC scores, embedding coordinates, tiling statistics, cell neighborhood features — cannot be used for coloring.
Users must work around this by manually copying the .obsm column into .obs, which pollutes the AnnData object and requires extra bookkeeping.
This is tracked in GitHub issue #587.
Minimal reproducible example
import matplotlib; matplotlib.use("Agg")
import matplotlib.pyplot as plt
import numpy as np, pandas as pd, geopandas as gpd, anndata as ad
import dask; dask.config.set({"dataframe.query-planning": False})
from shapely.geometry import box
import spatialdata as sd
from spatialdata.models import ShapesModel, TableModel
import spatialdata_plot
shapes = ShapesModel.parse(gpd.GeoDataFrame(
{"geometry": [box(i, 0, i+1, 1) for i in range(3)], "radius": [0.5]*3},
geometry="geometry"
))
obs = pd.DataFrame({
"region": pd.Categorical(["s"]*3),
"instance_id": [0, 1, 2],
})
adata = ad.AnnData(X=np.zeros((3, 1)), obs=obs)
# Per-cell QC metrics stored in obsm — cannot currently use for coloring
adata.obsm["spatial_qc"] = pd.DataFrame(
{"n_counts": [100.0, 250.0, 50.0], "density": [0.8, 0.6, 0.9]},
index=adata.obs_names
)
table = TableModel.parse(adata, region="s", region_key="region", instance_key="instance_id")
sdata = sd.SpatialData(shapes={"s": shapes}, tables={"t": table})
fig, ax = plt.subplots()
# Desired: sdata.pl.render_shapes("s", color="spatial_qc:n_counts").pl.show(ax=ax)
# Actual workaround needed:
adata.obs["n_counts"] = adata.obsm["spatial_qc"]["n_counts"].values
sdata.pl.render_shapes("s", color="n_counts").pl.show(ax=ax)
Expected behaviour
A syntax like color="spatial_qc:n_counts" (or equivalent) that lets users specify an obsm key and column directly, without manually copying into obs.
Actual behaviour
KeyError: "Unable to locate color key 'spatial_qc:n_counts' for element 's'."
.obsm is never checked in _validate_col_for_column_table (utils.py:2838–2872).
Feature request
Extend the color key resolution in _validate_col_for_column_table (and/or _locate_value) to support .obsm DataFrames. Possible syntaxes:
color="obsm_key:column"— explicit separatorcolor="column"with fallback to obsm keys whenobslookup fails- A dedicated
obsm_key=parameter
This would unlock a common workflow where spatial QC, embeddings, or multi-modal per-cell metrics are stored in .obsm and need to be visualized spatially.
Triage tier: Tier 3
- 主要言語
- Python
- スター
- 86
- フォーク
- 21
- 平均マージ
- 14時間 50分
- マージ済み PR(30日)
- 3
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
scverse/spatialdata-plot のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
scverse/spatialdata-plot#775 ·
-
bug
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
scverse/spatialdata-plot#777 ·
-
`pl.show()` leading to `ValueError` due to mismatch between number of axes and number of panels オープン
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
scverse/spatialdata-plot#749 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
scverse/spatialdata-plot#747 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 45/100
scverse/spatialdata-plot#677 ·
scverse/spatialdata-plot の issue をすべて見る
似ている issue
-
documentation help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
simonw/sqlite-utils#872 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100