add usage example to docs

Author: niklasmueboe

docs/source/conf.py

@@ -27,6 +27,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.autosummary",
     "sphinx.ext.mathjax",
+    "myst_nb",
 ]
 
 
@@ -41,6 +42,8 @@
 nitpicky = True
 nitpick_ignore = [("py:class", "optional")]
 
+# MyST-NB config
+nb_execution_timeout = 3 * 60
 
 exclude_patterns: list[str] = []
 
@@ -51,6 +54,7 @@
     python=("https://docs.python.org/3", None),
     scanpy=("https://scanpy.readthedocs.io/en/stable/", None),
     scipy=("https://docs.scipy.org/doc/scipy/", None),
+    squidpy=("https://squidpy.readthedocs.io/en/stable/", None),
 )
 
 # -- Options for HTML output -------------------------------------------------

docs/source/index.rst

@@ -16,6 +16,7 @@ but can also be used independently.
 
    self
    installation
+   usage
    api
 
 

docs/source/usage.md

@@ -0,0 +1,113 @@
+---
+file_format: mystnb
+kernelspec:
+  name: python
+jupytext:
+  text_representation:
+    extension: .md
+    format_name: myst
+    format_version: 0.13
+    jupytext_version: 1.16.2
+---
+
+# Usage
+
++++
+
+To demonstrate the usage of the `spatialleiden` package we are going to use a MERFISH data set from [Moffit _et al._ 2018](https://doi.org/10.1126/science.aau5324) that can be downloaded from [figshare](https://figshare.com/articles/dataset/MERFISH_datasets/22565170) and then loaded as {py:class}`anndata.AnnData` object.
+
+```{code-cell} ipython3
+---
+tags: [hide-cell]
+---
+
+from tempfile import NamedTemporaryFile
+from urllib.request import urlretrieve
+
+import anndata as ad
+
+with NamedTemporaryFile(suffix=".h5ad") as h5ad_file:
+    urlretrieve("https://figshare.com/ndownloader/files/40038538", h5ad_file.name)
+    adata = ad.read_h5ad(h5ad_file)
+```
+
+First of all we are going to load the relevant packages that we will be working with as well as setting a random seed that we will use throughout this example to make the results reproducible.
+
+```{code-cell} ipython3
+import scanpy as sc
+import spatialleiden as sl
+import squidpy as sq
+
+seed = 42
+```
+
+The data set consists of 155 genes and ~5,500 cells including their annotation for cell type as well as domains.
+
++++
+
+## SpatialLeiden
+
+We will do some standard preprocessing by log-transforming the data and then using PCA for dimensionality reduction. The PCA will be used to build a kNN graph in the latent gene expression space. This graph is the basis for the Leiden clustering.
+
+```{code-cell} ipython3
+sc.pp.log1p(adata)
+sc.pp.pca(adata, random_state=seed)
+
+sc.pp.neighbors(adata, random_state=seed)
+```
+
+For SpatialLeiden we need an additional graph representing the connectivities in the topological space. Here we will use a kNN graph with 10 neighbors that we generate with {py:func}`squidpy.gr.spatial_neighbors`. Alternatives are Delaunay triangulation or regular grids in case of e.g. Visium data.
+
+We can use the calculated distances between neighboring points and transform them into connectivities using the {py:func}`spatialleiden.distance2connectivity` function.
+
+```{code-cell} ipython3
+sq.gr.spatial_neighbors(adata, coord_type="generic", n_neighs=10)
+
+adata.obsp["spatial_connectivities"] = sl.distance2connectivity(
+    adata.obsp["spatial_distances"]
+)
+```
+
+Now, we can already run {py:func}`spatialleiden.spatialleiden` (which we will also compare to normal Leiden clustering).
+
+The `layer_ratio` determines the weighting between the gene expression and the topological layer and is influenced by the graph structures (i.e. how many connections exist, the edge weights, etc.); the lower the value is the closer SpatialLeiden will be to normal Leiden clustering, while higher values lead to more spatially homogeneous clusters.
+
+The resolution has the same effect as in Leiden clustering (higher resolution will lead to more clusters) and can be defined for each of the layers (but for now is left at its default value).
+
+```{code-cell} ipython3
+sc.tl.leiden(adata, directed=False, random_state=seed)
+
+sl.spatialleiden(adata, layer_ratio=1.8, directed=(False, True), seed=seed)
+
+sc.pl.embedding(adata, basis="spatial", color=["leiden", "spatialleiden"])
+```
+
+We can see how Leiden clustering identifies cell types while SpatialLeiden defines domains of the tissue.
+
++++
+
+## Resolution search
+
+If you already know how many domains you expect in your sample you can use the {py:func}`spatialleiden.search_resolution` function to identify the resolutions needed to obtain the correct number of clusters.
+
+Conceptually, this function first runs Leiden clustering multiple times while changing the resolution to identify the value leading to the desired number of clusters. Next, this procedure is repeated by running SpatialLeiden, but now the resolution of the latent layer (gene expression) is kept fixed and the resolution of the spatial layer is varied.
+
+```{code-cell} ipython3
+n_clusters = adata.obs["domain"].nunique()
+
+latent_resolution, spatial_resolution = sl.search_resolution(
+    adata,
+    n_clusters,
+    latent_kwargs={"seed": seed},
+    spatial_kwargs={"layer_ratio": 1.8, "seed": seed, "directed": (False, True)},
+)
+
+print(f"Latent resolution: {latent_resolution:.3f}")
+print(f"Spatial resolution: {spatial_resolution:.3f}")
+```
+
+In our case we can compare the resulting clusters to the annotated ground truth regions. If we are not satisfied with the results, we can go back and tweak other parameters such as the underlying neighborhood graphs or the `layer_ratio` to achieve the desired granularity of our results.
+
+```{code-cell} ipython3
+sc.pl.embedding(adata, basis="spatial", color=["spatialleiden", "Region"])
+```

pyproject.toml

@@ -34,7 +34,7 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
-docs = ["sphinx", "sphinx-copybutton", "sphinx-rtd-theme"]
+docs = ["sphinx", "sphinx-copybutton", "sphinx-rtd-theme", "squidpy", "myst-nb"]
 dev  = ["spatialleiden[docs]", "pre-commit"]
 
 [project.urls]