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: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,38 +18,38 @@
18
18
19
19
k-NN-based mapping of cells across representations to transfer labels, embeddings and expression values. Works for millions of cells, on CPU and GPU, across molecular modalities, between spatial and non-spatial data, for arbitrary query and reference datasets. Using [faiss][] to compute k-NN graphs, CellMapper takes about 30 seconds to transfer cell type labels from 1.5M cells to 1.5M cells on a single RTX 4090 with 60 GB CPU memory.
20
20
21
-
Inspired by previous tools, including scanpy's [ingest][] and the [HNOCA-tools][] packages. Check out the [docs][] to learn more, in particular our [tutorials][].
21
+
Inspired by previous tools, including scanpy's [ingest][] and the [HNOCA-tools][] packages. Check out the 📚 [docs][] to learn more, in particular our [tutorials][].
22
22
23
-
## Key use cases
23
+
## ✨ Key use cases
24
24
25
-
- Transfer cell type labels and expression values from dissociated to spatial datasets.
26
-
- Transfer embeddings between arbitrary query and reference datasets.
27
-
- Compute presence scores for query datasets in large reference atlasses.
28
-
- Identify niches in spatial datasets by contextualizing latent spaces in spatial coordinates.
29
-
- Evaluate the results of transferring labels, embeddings and feature spaces using a variety of metrics.
25
+
-🧬 Transfer cell type labels and expression values from dissociated to spatial datasets.
26
+
-↔️ Transfer embeddings between arbitrary query and reference datasets.
27
+
-📊 Compute presence scores for query datasets in large reference atlasses.
28
+
-🗺️ Identify niches in spatial datasets by contextualizing latent spaces in spatial coordinates.
29
+
-📈 Evaluate the results of transferring labels, embeddings and feature spaces using a variety of metrics.
30
30
31
31
The core idea of `CellMapper` is to separate the method (k-NN graph with some kernel applied to get a mapping matrix) from the application (mapping across arbitrary representations), to be flexible and fast. The tool currently supports [pynndescent][], [sklearn][], [faiss][] and [rapids][] for neighborhood search, implements a variety of graph kernels, and is closely integrated with `AnnData` objects.
32
32
33
-
## Installation
33
+
## 📦 Installation
34
34
35
-
You need to have Python 3.10 or newer installed on your system.
35
+
You need to have 🐍 Python 3.10 or newer installed on your system.
36
36
If you don't have Python installed, we recommend installing [uv][].
37
37
38
38
There are two alternative options to install ``cellmapper``:
This package assumes that you have ``query`` and ``reference`` AnnData objects, with a joint embedding computed and stored in ``.obsm``. While we implement some baseline approaches to compute joint embeddings (PCA and a fast reimplementation of CCA), we typically expect you to provide a pre-computed joint embedding from some task-specific representation learning tools, e.g. [GimVI][] or [ENVI][] for spatial mapping, [GLUE][], [MIDAS][] and [MOFA+][] for modality translation, and [scVI][], [scANVI][] and [scArches][] for query-to-reference mapping - this is just a small selection!
This will transfer data from the reference to the query dataset, including celltype labels stored in ``reference.obs``, a UMAP embedding stored in ``reference.obsm``, and expression values stored in ``reference.X``.
66
66
67
-
There are many ways to customize this, e.g. use different ways to compute k-NN graphs and to turn them into mapping matrices, and we implement a few methods to evaluate whether your k-NN transfer was sucessful. The tool also implements a `self-mapping` mode (only a query object, no reference), which is useful for spatial contextualization and data denoising. Check out the [docs][] to learn more.
67
+
There are many ways to customize this, e.g. use different ways to compute k-NN graphs and to turn them into mapping matrices, and we implement a few methods to evaluate whether your k-NN transfer was sucessful. The tool also implements a `self-mapping` mode (only a query object, no reference), which is useful for spatial contextualization and data denoising. Check out the 📚 [docs][] to learn more.
68
68
69
-
## Release notes
69
+
## 📝 Release notes
70
70
71
71
See the [changelog][].
72
72
73
-
## Contact
73
+
## 📬 Contact
74
74
75
75
If you found a bug, please use the [issue tracker][].
76
76
77
-
## Citation
77
+
## 📖 Citation
78
78
Please use our [zenodo][] entry to cite this software.
0 commit comments