scverse / scverse/spatialdata-plot
Adding plotting specific documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 86
- Forks
- 21
- Avg merge
- 14h 50m
- Merged PRs (30d)
- 3
Description
Comment originally from @MeyerBender, thanks for the feedback!
documentation: in general, I think it would be good to have one or two notebooks that exclusively focus on visualization. Right now, it is very hard to find this in the spatialdata docs. Maybe something similar to this, which shows off the most important plotting functions in spatialproteomics.
Currently we have plotting notebooks but hidden under the "Technology-specific" section in the docs. And we have another notebook in a separate repo (=not really discoverable).
Improving the docs with a visualization-specific notebook that is easily discoverable would be valuable.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the plotting notebooks under the docs' "Technology-specific" section and the existing spatialdata-workshops/notebooks/nb2_static_plotting.ipynb. Identify the key plotting functions and how notebooks are linked in the documentation. Done means a visualization-focused notebook is easy to discover in the spatialdata-plot docs and covers the important plotting functions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- data-visualization, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100