New docs section: how to integrate `spatialdata` in your tool
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 394
- Forks
- 95
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 7
Description
Aim: adding a page in the docs to help methods developers that want to use SpatialData in their tools.
The page could cover the following, showing how SpatialData could be used at various levels:
- Only downstream. E.g. visualization: one could handle everything outside SpatialData and just export to SpatialData to access napari-spatialdata, spatialdata-plot and soon vitessce
- Only upstream. E.g. data ingestion: one could use spatialdata-io to read the raw data from common techs into xarray/geopandas/anndata objects and forget about SpatialData objects
- Fully integrated. E.g. SOPA, bento-tools, squidpy: SpatialData is used as a core data structure for internal representation and (to different degrees) object manipulation.
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 existing documentation structure and the cited integrations: napari-spatialdata, spatialdata-plot, vitessce, spatialdata-io, SOPA, bento-tools, and squidpy. Done means adding a page that clearly explains downstream-only, upstream-only, and fully integrated uses of SpatialData for methods developers, with examples for each level.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100