scverse / scverse/spatialdata

Make a biological transformation notebook

Open
#747 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs 📜
Dominant language
Python
Stars
394
Forks
95
Avg merge
4d 3h
Merged PRs (30d)
7

Description

The transformation notebook is centered on showing how the API works and not in telling a biological story (for instance it uses a raccoon image image instead of a biological dataset).

This issue tracks our plan to move the notebook in a more technical section aimed at methods developers and make a new notebooks targeting analysts, where a biological story making use of our transformation system is presented.

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 by reading the linked transformation notebook and identify how it is currently organized around the API. Define the analyst-facing biological story and dataset, then determine how the existing notebook should move to a methods-focused section. Done means the technical notebook is relocated and a new analyst notebook demonstrates the transformation system through a biological use case.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.