Skip to content

Commit 059e286

Browse files
Updated figure in README (#62)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 3686f02 commit 059e286

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,20 @@
1212

1313
The `spatialdata-plot` package extends `spatialdata` with a declarative plotting API that enables to quickly visualize `spatialdata` objects and their respective elements (i.e. `images`, `labels`, `points` and `shapes`).
1414

15+
SpatialData’s plotting capabilities allow to quickly visualise all contained modalities. The user can specify which elements should be rendered (images, labels, points, shapes) and specify certain parameters for each layer, such as for example the intent to color shapes by a gene’s expression profile or which color to use for which image channel. When the plot is then eventually displayed, all transformations, alignments and coordinate systems are internally processed to form the final visualisation. In concordance with the general SpatialData philosophy, all modalities of the major spatial technologies are supported out of the box.
16+
1517
<img src='https://raw.githubusercontent.com/scverse/spatialdata-plot/main/docs/spatialdata-plot.png'/>
1618

1719
## Getting started
1820

19-
Please refer to the [documentation][link-docs]. In particular, the
21+
For more information on the `spatialdata` format, please refer to the [documentation](https://spatialdata.scverse.org/en/latest/). In particular, the
2022

2123
- [API documentation][link-api].
2224
- [Design doc][link-design-doc].
2325
- [Example notebooks][link-notebooks].
2426

27+
For usage examples, please refer to the ["Visualizations"](https://spatialdata.scverse.org/en/latest/tutorials/notebooks/notebooks.html#visualizations) section of `spatialdata`.
28+
2529
## Installation
2630

2731
You need to have Python 3.8 or newer installed on your system. If you don't have
@@ -43,10 +47,6 @@ pip install spatialdata-plot
4347
pip install git+https://github.com/scverse/spatialdata-plot.git@main
4448
```
4549

46-
## Release notes
47-
48-
See the [changelog][changelog].
49-
5050
## Contact
5151

5252
For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].

docs/spatialdata-plot.png

1.05 MB
Loading

0 commit comments

Comments
 (0)