singlecell-cookbook


Namesinglecell-cookbook JSON
Version 0.3.1 PyPI version JSON
download
home_pageNone
SummaryA collection of tools for analyzing single-cell genomics data.
upload_time2024-12-19 00:53:42
maintainerNone
docs_urlNone
authorNone
requires_python<3.13,>=3.11
licenseMIT License Copyright (c) 2024 Argenis Arriojas 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 rna-seq analysis bioinformatics genomics single-cell
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # singlecell-cookbook

[![Tests](https://github.com/argearriojas/singlecell-cookbook/actions/workflows/tests.yml/badge.svg)](https://github.com/argearriojas/singlecell-cookbook/actions/workflows/tests.yml)

A collection of tools for analyzing single-cell genomics data.

## Installation

You can install the package using pip:

```bash
pip install singlecell-cookbook
```

For development installation:

```bash
git clone https://github.com/argearriojas/singlecell-cookbook.git
cd singlecell-cookbook
pip install -e ".[dev]"
```

### R Dependencies

Some features (like pseudobulk analysis) require R and specific R packages. To use these features:

1. Install the required R packages in R:

```R
if (!require("BiocManager", quietly = TRUE))
    install.packages("BiocManager")

BiocManager::install(c("edgeR", "MAST"))
```

2. Install the R dependencies in Python:

```bash
pip install "singlecell-cookbook[r]"
```

## Documentation

Documentation is available at [Read the Docs](https://singlecell-cookbook.readthedocs.io/).

## Development

To set up the development environment:

1. Clone the repository
2. Install development dependencies: `pip install -e ".[dev]"`
3. Install pre-commit hooks: `pre-commit install`

## License

TBD. We need to assess the license according to the imported packages.

## Author

Argenis Arriojas ([arriojasmaldonado001@umb.edu](mailto:arriojasmaldonado001@umb.edu))

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "singlecell-cookbook",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.11",
    "maintainer_email": null,
    "keywords": "RNA-seq, analysis, bioinformatics, genomics, single-cell",
    "author": null,
    "author_email": "Argenis Arriojas <arriojasmaldonado001@umb.edu>",
    "download_url": "https://files.pythonhosted.org/packages/32/cb/1c4700530e65960736e630dac54e968c16986526bd9546249d5ac09cae88/singlecell_cookbook-0.3.1.tar.gz",
    "platform": null,
    "description": "# singlecell-cookbook\n\n[![Tests](https://github.com/argearriojas/singlecell-cookbook/actions/workflows/tests.yml/badge.svg)](https://github.com/argearriojas/singlecell-cookbook/actions/workflows/tests.yml)\n\nA collection of tools for analyzing single-cell genomics data.\n\n## Installation\n\nYou can install the package using pip:\n\n```bash\npip install singlecell-cookbook\n```\n\nFor development installation:\n\n```bash\ngit clone https://github.com/argearriojas/singlecell-cookbook.git\ncd singlecell-cookbook\npip install -e \".[dev]\"\n```\n\n### R Dependencies\n\nSome features (like pseudobulk analysis) require R and specific R packages. To use these features:\n\n1. Install the required R packages in R:\n\n```R\nif (!require(\"BiocManager\", quietly = TRUE))\n    install.packages(\"BiocManager\")\n\nBiocManager::install(c(\"edgeR\", \"MAST\"))\n```\n\n2. Install the R dependencies in Python:\n\n```bash\npip install \"singlecell-cookbook[r]\"\n```\n\n## Documentation\n\nDocumentation is available at [Read the Docs](https://singlecell-cookbook.readthedocs.io/).\n\n## Development\n\nTo set up the development environment:\n\n1. Clone the repository\n2. Install development dependencies: `pip install -e \".[dev]\"`\n3. Install pre-commit hooks: `pre-commit install`\n\n## License\n\nTBD. We need to assess the license according to the imported packages.\n\n## Author\n\nArgenis Arriojas ([arriojasmaldonado001@umb.edu](mailto:arriojasmaldonado001@umb.edu))\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 Argenis Arriojas  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 collection of tools for analyzing single-cell genomics data.",
    "version": "0.3.1",
    "project_urls": {
        "Documentation": "https://singlecell-cookbook.readthedocs.io",
        "Homepage": "https://github.com/argearriojas/singlecell-cookbook",
        "Issues": "https://github.com/argearriojas/singlecell-cookbook/issues",
        "Release Notes": "https://github.com/argearriojas/singlecell-cookbook/releases",
        "Repository": "https://github.com/argearriojas/singlecell-cookbook"
    },
    "split_keywords": [
        "rna-seq",
        " analysis",
        " bioinformatics",
        " genomics",
        " single-cell"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e9c687997a91c50f3df47de37a7678ab6b96f61da5a71c0ece408d8a81ee68ee",
                "md5": "29cf79195ebcf4ee491311628d1ca731",
                "sha256": "2f4f17e9a3d9ee9ab7219a2808601d17737eb6a1adbd5db8f3f68fb4ea028801"
            },
            "downloads": -1,
            "filename": "singlecell_cookbook-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "29cf79195ebcf4ee491311628d1ca731",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.11",
            "size": 17351,
            "upload_time": "2024-12-19T00:53:40",
            "upload_time_iso_8601": "2024-12-19T00:53:40.201047Z",
            "url": "https://files.pythonhosted.org/packages/e9/c6/87997a91c50f3df47de37a7678ab6b96f61da5a71c0ece408d8a81ee68ee/singlecell_cookbook-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "32cb1c4700530e65960736e630dac54e968c16986526bd9546249d5ac09cae88",
                "md5": "299eccf8f39a22e76d5b784286c232f9",
                "sha256": "3e651aeacb09978726e111e21fd3ac98e57f2edc1e7d4b476fac38aa6042133b"
            },
            "downloads": -1,
            "filename": "singlecell_cookbook-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "299eccf8f39a22e76d5b784286c232f9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.11",
            "size": 20529,
            "upload_time": "2024-12-19T00:53:42",
            "upload_time_iso_8601": "2024-12-19T00:53:42.222938Z",
            "url": "https://files.pythonhosted.org/packages/32/cb/1c4700530e65960736e630dac54e968c16986526bd9546249d5ac09cae88/singlecell_cookbook-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-19 00:53:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "argearriojas",
    "github_project": "singlecell-cookbook",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "singlecell-cookbook"
}
        
Elapsed time: 0.53321s