Pytorch implementation of Harmony algorithm on single-cell sequencing data integration
Project description
This is a Pytorch implementation of Harmony algorithm on single-cell sequencing data integration. Please see [Ilya Korsunsky et al., 2019](https://www.nature.com/articles/s41592-019-0619-0) for details.
Installation
This package is published on PyPI:
pip install harmony-pytorch
Usage
General Case
Given an embedding X as a N-by-d matrix in numpy array structure (N for number of cells, d for embedding components) and cell attributes as a Data Frame df_metadata, use Harmony for data integration as the following:
from harmony import harmonize Z = harmonize(X, df_metadata, batch_key = 'Channel')
where Channel is the attribute in df_metadata for batches.
Alternatively, if there are multiple attributes for batches, write:
Z = harmonize(X, df_metadata, batch_key = ['Lab', 'Date'])
Input as MultimodalData Object
It’s easy for Harmony-pytorch to work with count matrix data structure from PegasusIO package. Let data be a MultimodalData object in Python:
from harmony import harmonize Z = harmonize(data.obsm['X_pca'], data.obs, batch_key = 'Channel') data.obsm['X_pca_harmony'] = Z
This will calculate the harmonized PCA matrix for the default UnimodalData of data.
Given a UnimodalData object unidata, you can also use the code above to perform Harmony algorithm: simply substitute unidata for data there.
Input as AnnData Object
It’s easy for Harmony-pytorch to work with annotated count matrix data structure from anndata package. Let adata be an AnnData object in Python:
from harmony import harmonize Z = harmonize(adata.obsm['X_pca'], adata.obs, batch_key = '<your-batch-key>') adata.obsm['X_harmony'] = Z
where <your-batch-key> should be replaced by the actual batch key attribute name in your data.
For details about AnnData data structure, please refer to its documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for harmony_pytorch-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49d242dc0b01311a89644a5b66d22e79a909307ab775a44e907f96ac6417e866 |
|
MD5 | 9970701470f7775df6f5e2ee6a26693f |
|
BLAKE2b-256 | 6134e9c92aa7211c04356aa6d87cac6a839bce53e42558ecedefbc6025baa772 |