Skip to content

docs: add colouring by expression example (tables, layers, gene symbols) - #24

Open
timtreis wants to merge 3 commits into
mainfrom
feat/colour-by-expression
Open

docs: add colouring by expression example (tables, layers, gene symbols)#24
timtreis wants to merge 3 commits into
mainfrom
feat/colour-by-expression

Conversation

@timtreis

Copy link
Copy Markdown
Member

Summary

Adds examples/colouring_by_expression.ipynb documenting where render_* reads colour values from — table_name, table_layer, and gene_symbols (Group C of the round-2 gap analysis; all previously undocumented). Real 10x Visium mouse-brain dataset (squidpy.datasets.visium_hne_sdata()).

Covers:

  • color= by a gene (from the annotating table's X)
  • table_layer= to read from a specific matrix — adds a log1p layer and compares raw vs lognorm
  • gene_symbols= to look genes up by symbol when var is ID-indexed
  • table_name= to choose among multiple annotating tables

The dataset ships a single raw table, so the notebook constructs the extra layer, the gene-ID index, and a second QC table in-notebook (clearly flagged) to demonstrate each argument — real datasets often already carry them.

Executed against spatialdata-plot v0.4.1, committed with outputs. Adds the examples gallery card + toctree + thumbnail.

New examples/colouring_by_expression.ipynb on the real Visium mouse-brain
dataset (squidpy), documenting where render_* reads colour values from:

- color= by a gene (from the annotating table's X)
- table_layer= to read from a specific matrix (adds a log1p layer, raw vs lognorm)
- gene_symbols= to look genes up by symbol when var is ID-indexed
- table_name= to choose among multiple annotating tables

The dataset ships a single raw table, so the notebook constructs the layer,
the gene-ID index, and a second QC table in-notebook to demonstrate each arg.
Executed against spatialdata-plot v0.4.1; committed with outputs. Adds the
examples gallery card + toctree + thumbnail. Closes Group C of the round-2
doc-coverage analysis.
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions

github-actions Bot commented Aug 19, 2026

Copy link
Copy Markdown

📖 Docs preview: https://scverse.org/spatialdata-plot-tutorials/pr-24/gallery.html

Built from a5198a4; redeployed on every push.

github-actions Bot pushed a commit that referenced this pull request Aug 19, 2026
…rom throwaway SpatialData (non-destructive), define region keys, table_layer gene-only
github-actions Bot pushed a commit that referenced this pull request Aug 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant