You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user_guide.md
+30-32Lines changed: 30 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,17 +37,17 @@ Please see [this section](https://spatialdata.scverse.org/en/stable/tutorials/no
37
37
38
38
<detailsopen>
39
39
<summary><h3>If you have an existing Squidpy object.</summary>
40
-
40
+
41
41
Please have a look at [this tutorial](https://github.com/scverse/spatialdata-notebooks/blob/main/notebooks%2Fexamples%2Fsdata_from_scratch.ipynb).
42
-
42
+
43
43
</details>
44
-
44
+
45
45
<detailsopen>
46
46
<summary><h3>If you want to start from raw files</summary>
47
-
47
+
48
48
If you don’t have a SpatialData object or corresponding zarr file, you will have to create a SpatialData object to make use of the SpatialData framework.
49
-
You can create a SpatialData object directly from your raw files (e.g. CSVs, cell-gene matrix/cell-proteins matrix, images etc.) by using the [spatialdata-io](https://github.com/scverse/spatialdata-io) library that has reader functions for most spatial omics techniques. See [here](https://spatialdata.scverse.org/projects/io/en/latest/) for a list of currently supported technologies.
50
-
49
+
You can create a SpatialData object directly from your raw files (e.g. CSVs, cell-gene matrix/cell-proteins matrix, images etc.) by using the [spatialdata-io](https://github.com/scverse/spatialdata-io) library that has reader functions for most spatial omics techniques. See [here](https://spatialdata.scverse.org/projects/io/en/latest/) for a list of currently supported technologies.
50
+
51
51
For example, if you have data coming from a MERSCOPE®, just use:
52
52
53
53
```
@@ -61,12 +61,12 @@ Please also see [this section](https://spatialdata.scverse.org/en/stable/tutoria
61
61
If there is no reader implemented for your data type, please refer to [this section](https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks/examples/models1.html#construct-a-spatialdata-object-from-scratch) to learn about building SpatialData objects from scratch.
62
62
63
63
</details>
64
-
64
+
65
65
<detailsopen>
66
66
<summary><h3>If you want to play around with existing data.</summary>
67
-
67
+
68
68
Please see [here](https://spatialdata.scverse.org/en/stable/tutorials/notebooks/datasets/README.html) for a repository of demo datasets (already available as .zarr) generated with different spatial omics technologies.
69
-
69
+
70
70
</details>
71
71
</details>
72
72
@@ -92,41 +92,40 @@ Yes → Check out our [Transformation/coordinate system tutorial](https://spatia
92
92
</details>
93
93
94
94
<detailsopen>
95
-
<summary><h2>How do I annotate my data?</summary>
96
-
97
-
Annotation can have a lot of meanings. You might want to annotate specific regions in your tissue as tumor, add more details about your cell shapes, group together specific transcripts, include celltype annotations or cell sizes for your cells etc.
95
+
<summary><h2>How do I annotate my data?</summary>
96
+
97
+
Annotation can have a lot of meanings. You might want to annotate specific regions in your tissue as tumor, add more details about your cell shapes, group together specific transcripts, include celltype annotations or cell sizes for your cells etc.
98
98
<detailsopen>
99
99
<summary> <h3> How can I spatially annotate regions in my data? </summary>
100
-
100
+
101
101
This is possible within the SpatialData framework, making use of napari, like explained [in this tutorial](https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks/examples/napari_rois.html).
102
102
103
103
</details>
104
104
<detailsopen>
105
105
<summary> <h3> I have annotated regions in an external tool, how do I add them to SpatialData?</summary>
106
-
107
-
If the annotated regions are saved in a geojson, you can add them as follows:
108
-
```
106
+
107
+
If the annotated regions are saved in a geojson, you can add them as follows:
For more details, including information on how to add annotations for these regions, please have a look at [this tutorial](https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks/examples/tables.html).
113
115
114
116
</details>
115
-
117
+
116
118
<detailsopen>
117
-
118
-
119
+
119
120
<summary> <h3> I have cells in my dataset, how do I annotate them? (usage of AnnData)</summary>
120
121
121
122
One of the most obvious things to do for spatial omics data is to annotate cells using the [AnnData](https://anndata.readthedocs.io/en/stable/) format (called tables in SpatialData). These tables can contain count/intensity data, all types of annotations, and make it possible to make use of [scanpy](https://scanpy.readthedocs.io/en/stable/) functionality (normalization/clustering/DE calculation).
122
123
If you want more technical details on how to create a table from scratch to annotate your shapes/labels/points, you can have a look [here](https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks/examples/models2.html#tables).
123
124
124
125
</details>
125
-
126
-
127
-
126
+
128
127
</details>
129
-
128
+
130
129
<detailsopen>
131
130
<summary><h2>How do I analyze a spatial subset of my data?
132
131
</summary>
@@ -136,20 +135,19 @@ Therefore, subsampling your data based on spatial coordinates can be helpful. Ot
136
135
137
136
<detailsopen>
138
137
<summary><h3>I want to annotate a specific region myself.</summary>
139
-
138
+
140
139
Please see the previous section ('How do I annotate my data?') and then specifically the section about spatially annotating regions. This will guide you through the process of extracting coordinates, which will be used for spatially subsetting the data. Next, see below.
141
140
</details>
142
141
143
142
<detailsopen>
144
143
<summary><h3>I know the coordinates of the region I want to subsample.</summary>
145
-
144
+
146
145
You will need to perform a spatial query, which filters the data based on spatial coordinates. Please see [this tutorial](https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks/examples/spatial_query.html).
147
-
146
+
148
147
</details>
149
148
150
149
</details>
151
-
152
-
150
+
153
151
<detailsopen>
154
152
<summary><h2>How do I visualize my data?</summary>
155
153
@@ -191,9 +189,9 @@ The method of aggregation depends on the type of elements in your SpatialData ob
191
189
192
190
</details>
193
191
<detailsopen>
194
-
192
+
195
193
<summary> <h2> SpatialData looks amazing, I want to learn more. Give me all the technical details!</summary>
196
-
194
+
197
195
Sure, no problem! There is much more to learn about SpatialData.
198
196
199
197
You want to learn how to combine SpatialData and deep learning? We got you covered [here](https://spatialdata.scverse.org/en/stable/tutorials/notebooks/notebooks/examples/densenet.html).
@@ -203,9 +201,9 @@ If you want to create a labels layer from your shapes (rasterize), a shapes laye
203
201
Finally here is a more [advanced technical tutorial on transformations](https://spatialdata.scverse.org/en/latest/tutorials/notebooks/notebooks/examples/transformations_advanced.html#other-technical-topics).
204
202
205
203
</details>
206
-
204
+
207
205
<detailsopen>
208
-
206
+
209
207
<summary> <h2> I am sold, how can I get in touch and contribute to SpatialData?
0 commit comments