Skip to main content

The initial package of AlignDG

Project description

Alignment of distant slices of spatially resolved transcriptomics with graph learning model

Yu Wang, Zaiyi Liu, Qingchen Zhang, Xiaoke Ma

AlignDG is the first network-based model for aligning distant slices without prior information, covering scenarios such as non-consecutive, non-continuous, across different tissues and diseases conditions that cannot be properly handled with available methods. Furthermore, AlignDG joints feature learning and slice alignment, where features are learned under the guidance of alignment, thereby improving discriminative and quality of features. Extensive experimental results demonstrate the superiority of AlignDG over existing state-of-the-art in terms of precision, robustness and efficiency. AlignDG precisely tracks development of tissues from spatial-temporal slices by only using approximately 50% slices in datasets, which provides biologists with a new perspective to design experiments and analyze SRT data.

AlignDG workflow

Installation

To accelerate AlignDG by using GPU: If you have an NVIDIA GPU and using Linux OS, please install Pytorch and jaxlib-cuda in previous, the CPU version of them will be installed by default for you. Here is the installation guide of PyTorch and the installation guide of jaxlib.

1. Start by using python virtual environment with conda:

conda create --name aligndg python=3.10
conda activate aligndg

(Optional) To run the notebook files in tutorials, please ensure the Jupyter package is installed in your environment:

conda install -n aligndg ipykernel
python -m ipykernel install --user --name mnmst --display-name aligndg-jupyter

Note: If you encounter the error message "ImportError: Please install the skmisc package via pip install --user scikit-misc" while executing sc.pp.highly_variable_genes(adata, flavor='seurat_v3', n_top_genes=3000), please execute the following command in your terminal: pip install -i https://test.pypi.org/simple/ scikit-misc==0.2.0rc1.

2. From GitHub

git clone https://github.com/xkmaxidian/AlignDG.git

Tutorial

The jupyter Notebooks of the tutorial for the balanced simulate data (data 1 and 2) are accessible from :

https://github.com/xkmaxidian/AlignDG/blob/master/Tutorials/Tutorials_Simulate1_Banalced.ipynb

https://github.com/xkmaxidian/AlignDG/blob/master/Tutorials/Tutorials_Simulate2_Balanced.ipynb


The jupyter Notebook of the tutorial for the unbalanced simulate data is accessible from : https://github.com/xkmaxidian/AlignDG/blob/master/Tutorials/Tutorials_simulate.ipynb


The tutorials for AlignDG on real spatial transcriptomics are accessible from:


Tutorials for AlignDG on multiple slices and 3D reconstruction are accessible from:

Please install jupyter notebook in order to open this notebook.

Compared slice alignment algorithms in this paper:

Algorithms that are compared include:

We also acknowledge the authors who provided source code and data which inspire us a lot. They include:

Contact:

We are continuing adding new features. Bug reports or feature requests are welcome.

Last update: 01/24/2025, version 1.0.0

Please send any questions or found bugs to Xiaoke Ma xkma@xidian.edu.cn.

Reference

Our paper is under review.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aligndg-1.0.0.tar.gz (100.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aligndg-1.0.0-py3-none-any.whl (118.7 kB view details)

Uploaded Python 3

File details

Details for the file aligndg-1.0.0.tar.gz.

File metadata

  • Download URL: aligndg-1.0.0.tar.gz
  • Upload date:
  • Size: 100.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for aligndg-1.0.0.tar.gz
Algorithm Hash digest
SHA256 fe2b6f1855c3306ad2d00f4b7f1d0250e0dd25e9e5e6955992f94a11732a2286
MD5 62ca00ff70ec91c845f520e9bae207dc
BLAKE2b-256 bb8c33392a5db44e2df0a486fb7f1b2cf62212bc7c8fa27b8ef299c9702d2ca5

See more details on using hashes here.

File details

Details for the file aligndg-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: aligndg-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 118.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for aligndg-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0912a71c85ab26dc5dbc4dca17fa3ed0e25b607ff3a6623f064fddb9cc89a345
MD5 764254f77feec7529b778880098501ba
BLAKE2b-256 b40d9b62417645f11864124f121e8ecd6ad0f60a09d657a673c2b877cce3771c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page