Skip to content
This repository was archived by the owner on Aug 27, 2025. It is now read-only.

Commit 0049aee

Browse files
add documentation to readme
1 parent 264f07b commit 0049aee

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@
88
[![License](https://img.shields.io/pypi/l/spatialdata_xenium_explorer.svg)](https://github.com/quentinblampey/spatialdata_xenium_explorer/blob/master/LICENSE)
99
[![Imports: isort](https://img.shields.io/badge/imports-isort-blueviolet)](https://pycqa.github.io/isort/)
1010

11-
Converting any [`SpatialData`](https://github.com/scverse/spatialdata) object into files that can be open by the [Xenium Explorer](https://www.10xgenomics.com/support/software/xenium-explorer).
11+
Converting any [`SpatialData`](https://github.com/scverse/spatialdata) object into files that can be opened by the [Xenium Explorer](https://www.10xgenomics.com/support/software/xenium-explorer).
1212

1313
> *Xenium Explorer* is a registered trademark of 10x Genomics
1414
1515
You may also be interested in a pipeline for spatial-omics that uses this conversion to Xenium Explorer: see [Sopa](https://github.com/gustaveroussy/sopa).
1616

17+
Check [the documentation](https://quentinblampey.github.io/spatialdata_xenium_explorer/) to get started quickly.
18+
1719
## Installation
1820

1921
Requirement: `python>=3.9`
@@ -24,7 +26,7 @@ pip install spatialdata_xenium_explorer
2426

2527
## Features
2628

27-
- Conversion of the following data: images, cell boundaries (polygons), transcripts, cell-by-gene table, and cell categories (or observations).
29+
- Conversion of the following data: images, cell boundaries (polygons or spot), transcripts, cell-by-gene table, and cell categories (or observations).
2830
- Image alignment can be made on the Xenium Explorer, and then the `SpatialData` object can be updated
2931
- When working on the `SpatialData` or `AnnData` object, new cell categories can be easily and quickly added to the Explorer
3032
- When selecting cells with the "lasso tool" on the Explorer, it's easy to select back these cells on the `SpatialData` or `AnnData` object

0 commit comments

Comments
 (0)