scCODA


NamescCODA JSON
Version 0.1.9 PyPI version JSON
download
home_pagehttps://github.com/theislab/scCODA
SummaryA Dirichlet-Multinomial approach to identify compositional changes in count data.
upload_time2023-02-01 13:44:19
maintainer
docs_urlNone
authorJohannes Ostner, Benjamin Schubert
requires_python>=3.7.0
licenseBSD
keywords rna single cell composition coda compositional analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            
# scCODA - Single-cell differential composition analysis 
scCODA allows for identification of compositional changes in high-throughput sequencing count data, especially cell compositions from scRNA-seq.
It also provides a framework for integration of cell-type annotated data directly from [scanpy](https://scanpy.readthedocs.io/en/stable/) and other sources.
Aside from the scCODA model (Büttner, Ostner *et al* (2021)), the package also allows the easy application of other differential testing methods.

![scCODA](.github/Figures/Figure1.png)

The statistical methodology and benchmarking performance are described in:
 
Büttner, Ostner *et al* (2021). **scCODA is A Bayesian model for compositional single-cell data analysis**
([*Nature Communications*](https://www.nature.com/articles/s41467-021-27150-6))

Code for reproducing the analysis from the paper is available [here](https://github.com/theislab/scCODA_reproducibility).

For further information on the scCODA package and model, please refer to the 
[documentation](https://sccoda.readthedocs.io/en/latest/) and the 
[tutorials](https://github.com/theislab/scCODA/blob/master/tutorials).

## Installation

Running the package requires a working Python environment (>=3.8).

This package uses the `tensorflow` (`>=2.8`) and `tensorflow-probability` (`>=0.16`) packages.
The GPU computation features of these packages have not been tested with scCODA and are thus not recommended.
    
**To install scCODA via pip, call**:

    pip install sccoda


**To install scCODA from source**:

- Navigate to the directory that you want to install scCODA in
- Clone the repository from Github (https://github.com/theislab/scCODA):

    `git clone https://github.com/theislab/scCODA`

- Navigate to the root directory of scCODA:

    `cd scCODA`

- Install dependencies::

    `pip install -r requirements.txt`

- Install the package:

    `python setup.py install`

**Docker container**:

We provide a Docker container image for scCODA (https://hub.docker.com/repository/docker/wollmilchsau/scanpy_sccoda).

## Usage

Import scCODA in a Python session via:

    import sccoda

**Tutorials**

scCODA provides a number of tutorials for various purposes. Please also visit the [documentation](https://sccoda.readthedocs.io/en/latest/) for further information on the statistical model, data structure and API.

- The ["getting started" tutorial](https://sccoda.readthedocs.io/en/latest/getting_started.html) provides a quick-start guide for using scCODA.

- In the [advanced tutorial](https://sccoda.readthedocs.io/en/latest/Modeling_options_and_result_analysis.html), options for model specification, diagnostics, and result interpretation are disccussed.

- The [data import and visualization tutorial](https://sccoda.readthedocs.io/en/latest/Data_import_and_visualization.html) focuses on loading data from different sources and visualizing their characteristics.

- The [tutorial on other methods](https://sccoda.readthedocs.io/en/latest/using_other_compositional_methods.html) explains how to apply other methods for differential abundance testing from within scCODA.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/theislab/scCODA",
    "name": "scCODA",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7.0",
    "maintainer_email": "",
    "keywords": "RNA,single cell,composition,CODA,compositional analysis",
    "author": "Johannes Ostner, Benjamin Schubert",
    "author_email": "johannes.ostner@helmholtz-muenchen.de",
    "download_url": "https://files.pythonhosted.org/packages/ad/ca/8fc871aaf98d472810d60e29c097223c14975bf115e92c1b01aea2d40415/scCODA-0.1.9.tar.gz",
    "platform": null,
    "description": "\n# scCODA - Single-cell differential composition analysis \nscCODA allows for identification of compositional changes in high-throughput sequencing count data, especially cell compositions from scRNA-seq.\nIt also provides a framework for integration of cell-type annotated data directly from [scanpy](https://scanpy.readthedocs.io/en/stable/) and other sources.\nAside from the scCODA model (B\u00fcttner, Ostner *et al* (2021)), the package also allows the easy application of other differential testing methods.\n\n![scCODA](.github/Figures/Figure1.png)\n\nThe statistical methodology and benchmarking performance are described in:\n \nB\u00fcttner, Ostner *et al* (2021). **scCODA is A Bayesian model for compositional single-cell data analysis**\n([*Nature Communications*](https://www.nature.com/articles/s41467-021-27150-6))\n\nCode for reproducing the analysis from the paper is available [here](https://github.com/theislab/scCODA_reproducibility).\n\nFor further information on the scCODA package and model, please refer to the \n[documentation](https://sccoda.readthedocs.io/en/latest/) and the \n[tutorials](https://github.com/theislab/scCODA/blob/master/tutorials).\n\n## Installation\n\nRunning the package requires a working Python environment (>=3.8).\n\nThis package uses the `tensorflow` (`>=2.8`) and `tensorflow-probability` (`>=0.16`) packages.\nThe GPU computation features of these packages have not been tested with scCODA and are thus not recommended.\n    \n**To install scCODA via pip, call**:\n\n    pip install sccoda\n\n\n**To install scCODA from source**:\n\n- Navigate to the directory that you want to install scCODA in\n- Clone the repository from Github (https://github.com/theislab/scCODA):\n\n    `git clone https://github.com/theislab/scCODA`\n\n- Navigate to the root directory of scCODA:\n\n    `cd scCODA`\n\n- Install dependencies::\n\n    `pip install -r requirements.txt`\n\n- Install the package:\n\n    `python setup.py install`\n\n**Docker container**:\n\nWe provide a Docker container image for scCODA (https://hub.docker.com/repository/docker/wollmilchsau/scanpy_sccoda).\n\n## Usage\n\nImport scCODA in a Python session via:\n\n    import sccoda\n\n**Tutorials**\n\nscCODA provides a number of tutorials for various purposes. Please also visit the [documentation](https://sccoda.readthedocs.io/en/latest/) for further information on the statistical model, data structure and API.\n\n- The [\"getting started\" tutorial](https://sccoda.readthedocs.io/en/latest/getting_started.html) provides a quick-start guide for using scCODA.\n\n- In the [advanced tutorial](https://sccoda.readthedocs.io/en/latest/Modeling_options_and_result_analysis.html), options for model specification, diagnostics, and result interpretation are disccussed.\n\n- The [data import and visualization tutorial](https://sccoda.readthedocs.io/en/latest/Data_import_and_visualization.html) focuses on loading data from different sources and visualizing their characteristics.\n\n- The [tutorial on other methods](https://sccoda.readthedocs.io/en/latest/using_other_compositional_methods.html) explains how to apply other methods for differential abundance testing from within scCODA.\n\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "A Dirichlet-Multinomial approach to identify compositional changes in count data.",
    "version": "0.1.9",
    "split_keywords": [
        "rna",
        "single cell",
        "composition",
        "coda",
        "compositional analysis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "35e94f1ebf9efa3d0f34c6d2423ddbfa22c1a86ec2f9495af10ed49c0d3a35ae",
                "md5": "d0db219400fc73387318fe63371ba9b3",
                "sha256": "5f48321bf951fcc8f3bb0c9a033b19cd00df030a2690f42fa1401fd9d10dfd35"
            },
            "downloads": -1,
            "filename": "scCODA-0.1.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d0db219400fc73387318fe63371ba9b3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.0",
            "size": 36384,
            "upload_time": "2023-02-01T13:44:16",
            "upload_time_iso_8601": "2023-02-01T13:44:16.308294Z",
            "url": "https://files.pythonhosted.org/packages/35/e9/4f1ebf9efa3d0f34c6d2423ddbfa22c1a86ec2f9495af10ed49c0d3a35ae/scCODA-0.1.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "adca8fc871aaf98d472810d60e29c097223c14975bf115e92c1b01aea2d40415",
                "md5": "84580159db7e7eb88ac56dfad78d0477",
                "sha256": "786692a5ca546985583784179a6b2d535a54b37b30892fb9e264c5e854585dac"
            },
            "downloads": -1,
            "filename": "scCODA-0.1.9.tar.gz",
            "has_sig": false,
            "md5_digest": "84580159db7e7eb88ac56dfad78d0477",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.0",
            "size": 11413708,
            "upload_time": "2023-02-01T13:44:19",
            "upload_time_iso_8601": "2023-02-01T13:44:19.905014Z",
            "url": "https://files.pythonhosted.org/packages/ad/ca/8fc871aaf98d472810d60e29c097223c14975bf115e92c1b01aea2d40415/scCODA-0.1.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-01 13:44:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "theislab",
    "github_project": "scCODA",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "sccoda"
}
        
Elapsed time: 0.03439s