DeSide


NameDeSide JSON
Version 1.2.2 PyPI version JSON
download
home_page
SummaryA DEep-learning and SIngle-cell based DEconvolution method for solid tumors
upload_time2024-02-03 13:44:37
maintainer
docs_urlNone
author
requires_python>=3.8
licenseMIT License Copyright (c) 2022 Xin Xiong Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords deside rna-seq deconvolution
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # DeSide: Cellular Deconvolution of Bulk RNA-seq
<img src="https://raw.githubusercontent.com/OnlyBelter/DeSide/main/docs/_static/logo.png" width="300">

![PyPI version](https://img.shields.io/pypi/v/deside)
![Install with pip](https://img.shields.io/badge/Install%20with-pip-blue)
![MIT](https://img.shields.io/badge/License-MIT-black)

## What is DeSide?

DeSide is a DEep-learning and SIngle-cell based DEconvolution method for solid tumors, which can be used to infer cellular proportions of different cell types from bulk RNA-seq data.

DeSide consists of the following four parts (see figure below):
- DNN Model
- Single Cell Dataset Integration
- Cell Proportion Generation
- Bulk Tumor Synthesis

<img src="https://raw.githubusercontent.com/OnlyBelter/DeSide/main/Fig.1a_b.svg" width="800" alt="Overview of DeSide">

In this repository, we provide the code for implementing these four parts and visualizing the results.

## Requirements
DeSide requires Python 3.8 or higher. It has been tested on Linux and MacOS, but should work on Windows as well.
- tensorflow>=2.11.1
- scikit-learn==0.24.2
- anndata>=0.8.0
- scanpy==1.8.0
- umap-learn==0.5.1
- pandas==1.5.3
- numpy>=1.22
- matplotlib
- seaborn>=0.11.2
- bbknn==1.5.1
- SciencePlots
- matplotlib<3.7

## Installation

pip should work out of the box:
```shell
# creating a virtual environment is recommended
conda create -n deside python=3.8
conda activate deside
# update pip
python3 -m pip install --upgrade pip
# install deside
pip install deside
```

## Usage Examples
Usage examples can be found: [DeSide_mini_example](https://github.com/OnlyBelter/DeSide_mini_example)

Three examples are provided:
- Using pre-trained model
- Training a model from scratch
- Generating a synthetic dataset

## Documentation
For all detailed documentation, please check https://deside.readthedocs.io/. The documentation will demonstrate the usage of DeSide from the following aspects:
- Installation in a virtual environment
- Usage examples
- Datasets used in DeSide
- Functions and classes in DeSide


## License
DeSide can be used under the terms of the MIT License.

## Contact
Any questions or suggestions about DeSide are welcomed! Please report it on [issues](https://github.com/OnlyBelter/DeSide/issues), or contact Xin Xiong (onlybelter@outlook.com) or Xuefei Li (xuefei.li@siat.ac.cn).

## Manuscript
```text
@article {Xiong2023.05.11.540466,
	author = {Xin Xiong and Yerong Liu and Dandan Pu and Zhu Yang and Zedong Bi and Liang Tian and Xuefei Li},
	title = {DeSide: A unified deep learning approach for cellular decomposition of bulk tumors based on limited scRNA-seq data},
	elocation-id = {2023.05.11.540466},
	year = {2023},
	doi = {10.1101/2023.05.11.540466},
	URL = {https://www.biorxiv.org/content/early/2023/05/14/2023.05.11.540466},
	eprint = {https://www.biorxiv.org/content/early/2023/05/14/2023.05.11.540466.full.pdf},
	journal = {bioRxiv}
}
```



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "DeSide",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "DeSide,RNA-seq,deconvolution",
    "author": "",
    "author_email": "OnlyBelter <onlybelter@outlook.com>",
    "download_url": "https://files.pythonhosted.org/packages/a1/e9/5ffe3366b2c1c4585d43106b2e10b173be998851baaa24328d2941581536/DeSide-1.2.2.tar.gz",
    "platform": null,
    "description": "# DeSide: Cellular Deconvolution of Bulk RNA-seq\n<img src=\"https://raw.githubusercontent.com/OnlyBelter/DeSide/main/docs/_static/logo.png\" width=\"300\">\n\n![PyPI version](https://img.shields.io/pypi/v/deside)\n![Install with pip](https://img.shields.io/badge/Install%20with-pip-blue)\n![MIT](https://img.shields.io/badge/License-MIT-black)\n\n## What is DeSide?\n\nDeSide is a DEep-learning and SIngle-cell based DEconvolution method for solid tumors, which can be used to infer cellular proportions of different cell types from bulk RNA-seq data.\n\nDeSide consists of the following four parts (see figure below):\n- DNN Model\n- Single Cell Dataset Integration\n- Cell Proportion Generation\n- Bulk Tumor Synthesis\n\n<img src=\"https://raw.githubusercontent.com/OnlyBelter/DeSide/main/Fig.1a_b.svg\" width=\"800\" alt=\"Overview of DeSide\">\n\nIn this repository, we provide the code for implementing these four parts and visualizing the results.\n\n## Requirements\nDeSide requires Python 3.8 or higher. It has been tested on Linux and MacOS, but should work on Windows as well.\n- tensorflow>=2.11.1\n- scikit-learn==0.24.2\n- anndata>=0.8.0\n- scanpy==1.8.0\n- umap-learn==0.5.1\n- pandas==1.5.3\n- numpy>=1.22\n- matplotlib\n- seaborn>=0.11.2\n- bbknn==1.5.1\n- SciencePlots\n- matplotlib<3.7\n\n## Installation\n\npip should work out of the box:\n```shell\n# creating a virtual environment is recommended\nconda create -n deside python=3.8\nconda activate deside\n# update pip\npython3 -m pip install --upgrade pip\n# install deside\npip install deside\n```\n\n## Usage Examples\nUsage examples can be found: [DeSide_mini_example](https://github.com/OnlyBelter/DeSide_mini_example)\n\nThree examples are provided:\n- Using pre-trained model\n- Training a model from scratch\n- Generating a synthetic dataset\n\n## Documentation\nFor all detailed documentation, please check https://deside.readthedocs.io/. The documentation will demonstrate the usage of DeSide from the following aspects:\n- Installation in a virtual environment\n- Usage examples\n- Datasets used in DeSide\n- Functions and classes in DeSide\n\n\n## License\nDeSide can be used under the terms of the MIT License.\n\n## Contact\nAny questions or suggestions about DeSide are welcomed! Please report it on [issues](https://github.com/OnlyBelter/DeSide/issues), or contact Xin Xiong (onlybelter@outlook.com) or Xuefei Li (xuefei.li@siat.ac.cn).\n\n## Manuscript\n```text\n@article {Xiong2023.05.11.540466,\n\tauthor = {Xin Xiong and Yerong Liu and Dandan Pu and Zhu Yang and Zedong Bi and Liang Tian and Xuefei Li},\n\ttitle = {DeSide: A unified deep learning approach for cellular decomposition of bulk tumors based on limited scRNA-seq data},\n\telocation-id = {2023.05.11.540466},\n\tyear = {2023},\n\tdoi = {10.1101/2023.05.11.540466},\n\tURL = {https://www.biorxiv.org/content/early/2023/05/14/2023.05.11.540466},\n\teprint = {https://www.biorxiv.org/content/early/2023/05/14/2023.05.11.540466.full.pdf},\n\tjournal = {bioRxiv}\n}\n```\n\n\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2022 Xin Xiong  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A DEep-learning and SIngle-cell based DEconvolution method for solid tumors",
    "version": "1.2.2",
    "project_urls": {
        "Homepage": "https://github.com/OnlyBelter/DeSide",
        "Source": "https://github.com/OnlyBelter/DeSide",
        "Tracker": "https://github.com/OnlyBelter/DeSide/issues"
    },
    "split_keywords": [
        "deside",
        "rna-seq",
        "deconvolution"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "eca9dac73ab0814f9e65cd1f0c9cd278a07acd5258277798051a5b39ec5399f1",
                "md5": "a9bd4d64a0ddd4afbdc8debce3b13e49",
                "sha256": "6518d7e0ee63ff3ec8f549d6416ccfe89ecad61f00cc8b956c74ec34788105da"
            },
            "downloads": -1,
            "filename": "DeSide-1.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a9bd4d64a0ddd4afbdc8debce3b13e49",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 98396,
            "upload_time": "2024-02-03T13:44:34",
            "upload_time_iso_8601": "2024-02-03T13:44:34.275989Z",
            "url": "https://files.pythonhosted.org/packages/ec/a9/dac73ab0814f9e65cd1f0c9cd278a07acd5258277798051a5b39ec5399f1/DeSide-1.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1e95ffe3366b2c1c4585d43106b2e10b173be998851baaa24328d2941581536",
                "md5": "f4ccf7912c48db7fb69eef249002db4c",
                "sha256": "dad249074711b6e564443c38eb3f830599e87275eb854897b99ee990207c2bc9"
            },
            "downloads": -1,
            "filename": "DeSide-1.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "f4ccf7912c48db7fb69eef249002db4c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 152399,
            "upload_time": "2024-02-03T13:44:37",
            "upload_time_iso_8601": "2024-02-03T13:44:37.195644Z",
            "url": "https://files.pythonhosted.org/packages/a1/e9/5ffe3366b2c1c4585d43106b2e10b173be998851baaa24328d2941581536/DeSide-1.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-03 13:44:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OnlyBelter",
    "github_project": "DeSide",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "deside"
}
        
Elapsed time: 0.17452s