|
1 | 1 | # Kandinsky
|
2 | 2 |
|
3 | 3 | ## Overview <img src="man/figures/logo.png" align="right" height="138" alt="" />
|
4 |
| -Kandinsky is a spatial analysis toolkit designed to provide a compendium of methods to study cell and spot spatial neighbourhoods using spatial transcriptomic and proteomic data. |
| 4 | + |
| 5 | +Kandinsky is an R package developed for deriving functional insights on cellular ecosystems from neighbour analysis of spatial omics data. Kandinsky implements different approaches for cell or spot neighbourhood identification and analysis, including supervised and unsupervised clustering for downstream functional investigations, spatial co-localisation or dispersion, and detection of gene expression patterns. |
5 | 6 |
|
6 | 7 | <img src="man/figures/Kandinsky_Overview.png" align="center" height="500" alt="" />
|
7 | 8 |
|
8 | 9 |
|
9 |
| -As an input, Kandinsky uses gene or protein expression values and cell or spot coordinates deriving from any spatial transcriptomic or proteomic platform and implements helper functions to automate their loading and formatting into a Seurat object.\ |
10 |
| -Starting from their coordinates, Kandinsky groups cells or spots into neighbourhoods (c/s-NBs) according to their reciprocal spatial relationships inferred with five methods:\ |
11 |
| - - K-nearest neighbours (KNN);\ |
12 |
| - - Cell/spot centroid distance;\ |
13 |
| - - Delaunay triangulation;\ |
14 |
| - - Queen contiguity;\ |
15 |
| - - cell membrane distance. |
| 10 | +As input, Kandinsky requires: |
| 11 | + gene or protein expression values |
| 12 | + cell or spot coordinates |
| 13 | + derived from spatial transcriptomic or proteomic data. |
| 14 | + |
| 15 | +Kandinsky implements helper functions to process data loading and formatting into a Seurat object. Using spatial coordinates, Kandinsky groups cells or spots into neighbourhoods (c/s-NBs) according to spatial relationships measured as inferred with five methods: |
| 16 | + - K-nearest neighbours (KNN); |
| 17 | + - Cell/spot centroid distance; |
| 18 | + - Delaunay triangulation; |
| 19 | + - Queen contiguity; |
| 20 | + - Membrane distance. |
16 | 21 |
|
17 |
| -KNN, centroid distance, and Delaunay triangulation are applicable to both spot and cell data, while Queen contiguity is limited to spot data and membrane distances can be measured only from single cell segmentation data. |
| 22 | +KNN, centroid distance, and Delaunay triangulation are applicable to both spots and cells, while Queen contiguity is limited to spot data and membrane distances can be measured only from single cell segmentation data. |
18 | 23 |
|
19 |
| -Once defined, c/s-NBs can be used to derive clusters with similar composition, measure spatial co-localisation or dispersion and infer hot and cold gene expression areas. |
| 24 | +Once defined, c/s-NBs can be used together with cell/spot type annotation and expression values to (1) group cells, spots, or c/s-NBs, (2) measure their co-localisation or dispersion and (3) derive hot and cold expression areas within the tissue. |
20 | 25 |
|
21 | 26 | ## Setting up Kandinsky environment
|
22 |
| -To speed up package installation in R, user can first create a conda environment starting from the environment.yaml file. |
23 |
| -This will make available most of Kandinsky dependencies before downloading it. |
| 27 | +To simplify the installation process, users can first set up a conda environment using the environment.yaml file. |
| 28 | + |
24 | 29 |
|
25 | 30 | For conda users:
|
26 | 31 | ```
|
@@ -57,8 +62,7 @@ git clone https://github.com/ciccalab/Kandinsky.git
|
57 | 62 | #Alternative code for SSH connection: git clone git@github.com:ciccalab/Kandinsky.git
|
58 | 63 | ```
|
59 | 64 |
|
60 |
| -After downloading the repository, change directory to `Kandinsky/` and use `devtools` to install the package: |
61 |
| - |
| 65 | +Then, move into `Kandinsky/` folder and install the package: |
62 | 66 | ```
|
63 | 67 | cd Kandinsky/
|
64 | 68 | R
|
|
0 commit comments