CellClear


NameCellClear JSON
Version 0.0.2 PyPI version JSON
download
home_pageNone
SummaryEstimating and removing ambient expression in scRNA-seq data
upload_time2024-08-20 04:18:17
maintainerNone
docs_urlNone
authorWhiteRabBio
requires_python>=3.9
licenseBSD 3-Clause License Copyright (c) 2024, WhiteRabBio Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords scrna-seq bioinformatics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # CellClear: Enhancing scRNA-seq Data Quality via Biologically-Informed Ambient RNA Correction

<img src="https://github.com/WhiteRabBio/CellClear/blob/main/method.png" width="1000">



## Installation

**CellClear** can be installed from the python repository pypi (https://pypi.org/project/CellClear/)



## **Running CellClear**

A typical **CellClear** run with default settings would look like this:

```python
CellClear correct_expression --filtered_mtx_path filtered_feature_bc_matrix --raw_mtx_path raw_feature_bc_matrix --prefix test --output .
```

For full usage details with additional options, see "CellClear correct_expression --help".



## CellClear outputs 

(1) Determine the ambient RNA  expression level

(2) Give the identified ambient genes

(3) Remove the ambient RNA from each cell and output a new matrix


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "CellClear",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "scRNA-seq, bioinformatics",
    "author": "WhiteRabBio",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a4/e7/fa8a3967191d9a56a653a2777c0bd040934e35473a96d6836c80513a564b/cellclear-0.0.2.tar.gz",
    "platform": null,
    "description": "# CellClear: Enhancing scRNA-seq Data Quality via Biologically-Informed Ambient RNA Correction\n\n<img src=\"https://github.com/WhiteRabBio/CellClear/blob/main/method.png\" width=\"1000\">\n\n\n\n## Installation\n\n**CellClear** can be installed from the python repository pypi (https://pypi.org/project/CellClear/)\n\n\n\n## **Running CellClear**\n\nA typical **CellClear** run with default settings would look like this:\n\n```python\nCellClear correct_expression --filtered_mtx_path filtered_feature_bc_matrix --raw_mtx_path raw_feature_bc_matrix --prefix test --output .\n```\n\nFor full usage details with additional options, see \"CellClear correct_expression --help\".\n\n\n\n## CellClear outputs \n\n(1) Determine the ambient RNA  expression level\n\n(2) Give the identified ambient genes\n\n(3) Remove the ambient RNA from each cell and output a new matrix\n\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2024, WhiteRabBio  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
    "summary": "Estimating and removing ambient expression in scRNA-seq data",
    "version": "0.0.2",
    "project_urls": null,
    "split_keywords": [
        "scrna-seq",
        " bioinformatics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "41b97d3834b13831573955a80513eaba369ab8ed5a0517601b95ec46c4616aec",
                "md5": "298fa1704da9dfc3494b54bedaa34ef4",
                "sha256": "6f62e4bfea49caf3b308c950cc0b34f327e109bf9540d30bac41dcb882414462"
            },
            "downloads": -1,
            "filename": "CellClear-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "298fa1704da9dfc3494b54bedaa34ef4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 19530,
            "upload_time": "2024-08-20T04:18:15",
            "upload_time_iso_8601": "2024-08-20T04:18:15.387504Z",
            "url": "https://files.pythonhosted.org/packages/41/b9/7d3834b13831573955a80513eaba369ab8ed5a0517601b95ec46c4616aec/CellClear-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4e7fa8a3967191d9a56a653a2777c0bd040934e35473a96d6836c80513a564b",
                "md5": "68e8f5fa452b15751acc9c0dd478e9c8",
                "sha256": "204a9827473b3b910d760ab0e16b4939f442a3c06d731ab2d71c4586304f23e0"
            },
            "downloads": -1,
            "filename": "cellclear-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "68e8f5fa452b15751acc9c0dd478e9c8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 16938,
            "upload_time": "2024-08-20T04:18:17",
            "upload_time_iso_8601": "2024-08-20T04:18:17.043660Z",
            "url": "https://files.pythonhosted.org/packages/a4/e7/fa8a3967191d9a56a653a2777c0bd040934e35473a96d6836c80513a564b/cellclear-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-20 04:18:17",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "cellclear"
}
        
Elapsed time: 6.03950s