SMOPCA


NameSMOPCA JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/cmhimself/SMOPCA
SummaryA novel spatially aware multi-omics dimension reduction method
upload_time2024-08-30 09:53:01
maintainerNone
docs_urlNone
authorMo Chen
requires_python>=3.10.0
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Spatial Multi-Omics PCA

Spatial Multi-Omics PCA (SMOPCA) is a novel dimension reduction method to integrate multi-modal data and extract low-dimensional representations with preserved spatial dependencies among spots.

![](https://github.com/cmhimself/SMOPCA/blob/main/img/fig1.jpg?raw=true)

## Installation

SMOPCA can be installed directly from PyPI using the following command:
```
pip install SMOPCA
```

## Run SMOPCA

1. Prepare input data
   - SMOPCA accepts gene expression and protein/atac data matrices. Each modality of the data is preprocessed and normalized  separately. Initially, genes and proteins with zero counts were filtered out. Subsequently, the count matrix was normalized based on library size, followed by log-transformation and scaling to achieve unit variance and zero mean. ATAC reads are mapped to gene regions and the peak matrix is collapsed into a gene activity matrix, adhering to the established protocol from the Satija lab. The gene activity matrix was preprocessed and normalized using the same method as applied to mRNA data. Finally, we recommend to save the data into a hdf5 file.
   - Note that SMOPCA takes input matrices with columns corresponding to cells or spots.
2. Specify model hyperparameters and Model training
   - the dimensionality of the latent factors (default 20)
   - the kernel type (default matern kernel)
   - the length_scale parameter (We set length_scale=0.25 for UMAP coordinates and length_scale=5 for simulated and real spatial coordinates.)
   - For the rest of the parameters, see more in tutorials.
3. Downstream analysis
   - Visualization
   - Clustering analysis
   - Differential expression analysis
   - and many other tasks

## Datasets

Sample datasets are provided in ./data folder. The rest of the datasets used in this study are available at https://drive.google.com/drive/folders/11RfeF_yrdSGRtXZnzPlfxojM5V4ezMVr?usp=drive_link

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cmhimself/SMOPCA",
    "name": "SMOPCA",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10.0",
    "maintainer_email": null,
    "keywords": null,
    "author": "Mo Chen",
    "author_email": "mochen@smail.nju.edu.cn",
    "download_url": "https://files.pythonhosted.org/packages/43/75/6e528d295233f825ab43e97214241df70441c49c1fa8d3ef12a3bb031abe/smopca-0.1.1.tar.gz",
    "platform": null,
    "description": "# Spatial Multi-Omics PCA\n\nSpatial Multi-Omics PCA (SMOPCA) is a novel dimension reduction method to integrate multi-modal data and extract low-dimensional representations with preserved spatial dependencies among spots.\n\n![](https://github.com/cmhimself/SMOPCA/blob/main/img/fig1.jpg?raw=true)\n\n## Installation\n\nSMOPCA can be installed directly from PyPI using the following command:\n```\npip install SMOPCA\n```\n\n## Run SMOPCA\n\n1. Prepare input data\n   - SMOPCA accepts gene expression and protein/atac data matrices. Each modality of the data is preprocessed and normalized  separately. Initially, genes and proteins with zero counts were filtered out. Subsequently, the count matrix was normalized based on library size, followed by log-transformation and scaling to achieve unit variance and zero mean. ATAC reads are mapped to gene regions and the peak matrix is collapsed into a gene activity matrix, adhering to the established protocol from the Satija lab. The gene activity matrix was preprocessed and normalized using the same method as applied to mRNA data. Finally, we recommend to save the data into a hdf5 file.\n   - Note that SMOPCA takes input matrices with columns corresponding to cells or spots.\n2. Specify model hyperparameters and Model training\n   - the dimensionality of the latent factors (default 20)\n   - the kernel type (default matern kernel)\n   - the length_scale parameter (We set length_scale=0.25 for UMAP coordinates and length_scale=5 for simulated and real spatial coordinates.)\n   - For the rest of the parameters, see more in tutorials.\n3. Downstream analysis\n   - Visualization\n   - Clustering analysis\n   - Differential expression analysis\n   - and many other tasks\n\n## Datasets\n\nSample datasets are provided in ./data folder. The rest of the datasets used in this study are available at https://drive.google.com/drive/folders/11RfeF_yrdSGRtXZnzPlfxojM5V4ezMVr?usp=drive_link\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A novel spatially aware multi-omics dimension reduction method",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/cmhimself/SMOPCA"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ae93f177b828f85ece7f62e94bf259a0c6b941828978b7d24ee012585814715a",
                "md5": "6f878f0fda83cc0539434abd1bfb772f",
                "sha256": "84d98c44069053f0f88f566cc2b89afd053b6330d92f2c9ecc6cab37fd945e57"
            },
            "downloads": -1,
            "filename": "SMOPCA-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6f878f0fda83cc0539434abd1bfb772f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10.0",
            "size": 8597,
            "upload_time": "2024-08-30T09:52:59",
            "upload_time_iso_8601": "2024-08-30T09:52:59.586589Z",
            "url": "https://files.pythonhosted.org/packages/ae/93/f177b828f85ece7f62e94bf259a0c6b941828978b7d24ee012585814715a/SMOPCA-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "43756e528d295233f825ab43e97214241df70441c49c1fa8d3ef12a3bb031abe",
                "md5": "11ce9eee50bc2b005d20b1e19ac03d03",
                "sha256": "9d2bccc1b56f56e36117088dacdd06111488069c76af1925159db29483e5a455"
            },
            "downloads": -1,
            "filename": "smopca-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "11ce9eee50bc2b005d20b1e19ac03d03",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10.0",
            "size": 8579,
            "upload_time": "2024-08-30T09:53:01",
            "upload_time_iso_8601": "2024-08-30T09:53:01.111903Z",
            "url": "https://files.pythonhosted.org/packages/43/75/6e528d295233f825ab43e97214241df70441c49c1fa8d3ef12a3bb031abe/smopca-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-30 09:53:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cmhimself",
    "github_project": "SMOPCA",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "smopca"
}
        
Elapsed time: 0.62129s