anansescanpy


Nameanansescanpy JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://github.com/Arts-of-coding/AnanseScanpy
Summaryimplementation of scANANSE for scanpy objects in Python
upload_time2023-01-12 10:53:50
maintainer
docs_urlNone
authorJ Arts (Arts-of-coding)
requires_python>3.8
licenseapache 2.0
keywords grn single-cell gene expression open chromatin arts-of-coding
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## `AnanseScanpy` package: implementation of scANANSE for Scanpy objects in Python
[![Anaconda-Server Badge](https://anaconda.org/bioconda/anansescanpy/badges/version.svg)](https://anaconda.org/bioconda/anansescanpy)
[![PyPI version](https://badge.fury.io/py/anansescanpy.svg)](https://badge.fury.io/py/anansescanpy)
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/anansescanpy/README.html)
[![Anaconda-Server Badge](https://anaconda.org/bioconda/anansescanpy/badges/downloads.svg)](https://anaconda.org/bioconda/anansescanpy)
[![Maintainability](https://api.codeclimate.com/v1/badges/04272eaade7b247b4af2/maintainability)](https://codeclimate.com/github/Arts-of-coding/AnanseScanpy/maintainability)


## Installation

The most straightforward way to install the most recent version of AnanseScanpy is via conda using PyPI.

### Install package through Conda
If you have not used Bioconda before, first set up the necessary channels (in this order!). 
You only have to do this once.
```
$ conda config --add channels defaults
$ conda config --add channels bioconda
$ conda config --add channels conda-forge
```

Then install AnanseScanpy with:
```
$ conda install anansescanpy
```

### Install package through PyPI
```
$ pip install anansescanpy
```

### Install package through GitHub
```
$ git clone https://github.com/Arts-of-coding/AnanseScanpy.git
$ cd AnanseScanpy
$ conda env create -f requirements.yaml
$ conda activate AnanseScanpy
$ pip install -e .
```

### Install Jupyter Notebook
```
$ pip install jupyter
```

## Start using the package

### Run the package either in the console
```
$ python3
```

### Or run the package in jupyter notebook
```
$ jupyter notebook
```

## For extended documentation see our ipynb vignette with PBMC sample data
### Of which the sample data can be downloaded
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7446267.svg)](https://doi.org/10.5281/zenodo.7446267)
```
$ wget https://zenodo.org/record/7446267/files/rna_PBMC.h5ad -O scANANSE/rna_PBMC.h5ad
$ wget https://zenodo.org/record/7446267/files/atac_PBMC.h5ad -O scANANSE/atac_PBMC.h5ad
```

### installing and running anansnake 

Follow the instructions its respective github page, https://github.com/vanheeringen-lab/anansnake
Next automatically use the generated files to run GRN analysis using your single cell cluster data:


```{bash eval=FALSE}
snakemake --use-conda --conda-frontend mamba \
--configfile scANANSE/analysis/config.yaml \
--snakefile scANANSE/anansnake/Snakefile \
--resources mem_mb=48_000 --cores 12
```

### Thanks to:

* Jos Smits and his Seurat equivalent of this package https://github.com/JGASmits/AnanseSeurat
* Siebren Frohlich and his anansnake implementation https://github.com/vanheeringen-lab/anansnake

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Arts-of-coding/AnanseScanpy",
    "name": "anansescanpy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">3.8",
    "maintainer_email": "",
    "keywords": "GRN,single-cell,gene expression,open chromatin,arts-of-coding",
    "author": "J Arts (Arts-of-coding)",
    "author_email": "julian.armando.arts@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d3/5d/20b29cda1736ee022393d8609338ebec3addb604ad645b9b9268e36cf8c6/anansescanpy-1.0.0.tar.gz",
    "platform": null,
    "description": "## `AnanseScanpy` package: implementation of scANANSE for Scanpy objects in Python\n[![Anaconda-Server Badge](https://anaconda.org/bioconda/anansescanpy/badges/version.svg)](https://anaconda.org/bioconda/anansescanpy)\n[![PyPI version](https://badge.fury.io/py/anansescanpy.svg)](https://badge.fury.io/py/anansescanpy)\n[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/anansescanpy/README.html)\n[![Anaconda-Server Badge](https://anaconda.org/bioconda/anansescanpy/badges/downloads.svg)](https://anaconda.org/bioconda/anansescanpy)\n[![Maintainability](https://api.codeclimate.com/v1/badges/04272eaade7b247b4af2/maintainability)](https://codeclimate.com/github/Arts-of-coding/AnanseScanpy/maintainability)\n\n\n## Installation\n\nThe most straightforward way to install the most recent version of AnanseScanpy is via conda using PyPI.\n\n### Install package through Conda\nIf you have not used Bioconda before, first set up the necessary channels (in this order!). \nYou only have to do this once.\n```\n$ conda config --add channels defaults\n$ conda config --add channels bioconda\n$ conda config --add channels conda-forge\n```\n\nThen install AnanseScanpy with:\n```\n$ conda install anansescanpy\n```\n\n### Install package through PyPI\n```\n$ pip install anansescanpy\n```\n\n### Install package through GitHub\n```\n$ git clone https://github.com/Arts-of-coding/AnanseScanpy.git\n$ cd AnanseScanpy\n$ conda env create -f requirements.yaml\n$ conda activate AnanseScanpy\n$ pip install -e .\n```\n\n### Install Jupyter Notebook\n```\n$ pip install jupyter\n```\n\n## Start using the package\n\n### Run the package either in the console\n```\n$ python3\n```\n\n### Or run the package in jupyter notebook\n```\n$ jupyter notebook\n```\n\n## For extended documentation see our ipynb vignette with PBMC sample data\n### Of which the sample data can be downloaded\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7446267.svg)](https://doi.org/10.5281/zenodo.7446267)\n```\n$ wget https://zenodo.org/record/7446267/files/rna_PBMC.h5ad -O scANANSE/rna_PBMC.h5ad\n$ wget https://zenodo.org/record/7446267/files/atac_PBMC.h5ad -O scANANSE/atac_PBMC.h5ad\n```\n\n### installing and running anansnake \n\nFollow the instructions its respective github page, https://github.com/vanheeringen-lab/anansnake\nNext automatically use the generated files to run GRN analysis using your single cell cluster data:\n\n\n```{bash eval=FALSE}\nsnakemake --use-conda --conda-frontend mamba \\\n--configfile scANANSE/analysis/config.yaml \\\n--snakefile scANANSE/anansnake/Snakefile \\\n--resources mem_mb=48_000 --cores 12\n```\n\n### Thanks to:\n\n* Jos Smits and his Seurat equivalent of this package https://github.com/JGASmits/AnanseSeurat\n* Siebren Frohlich and his anansnake implementation https://github.com/vanheeringen-lab/anansnake\n",
    "bugtrack_url": null,
    "license": "apache 2.0",
    "summary": "implementation of scANANSE for scanpy objects in Python",
    "version": "1.0.0",
    "split_keywords": [
        "grn",
        "single-cell",
        "gene expression",
        "open chromatin",
        "arts-of-coding"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "de6e9bbd3d9262858a150c4d73a18745071847650ca761a57661e0f07ece72c8",
                "md5": "f9fe6896a2d1d175f11ba37fb1520d02",
                "sha256": "c03962339de21d97e7a8a8bddd185cbadd5885c9f5d0d060e148207c116c0755"
            },
            "downloads": -1,
            "filename": "anansescanpy-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f9fe6896a2d1d175f11ba37fb1520d02",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">3.8",
            "size": 16447,
            "upload_time": "2023-01-12T10:53:48",
            "upload_time_iso_8601": "2023-01-12T10:53:48.426395Z",
            "url": "https://files.pythonhosted.org/packages/de/6e/9bbd3d9262858a150c4d73a18745071847650ca761a57661e0f07ece72c8/anansescanpy-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d35d20b29cda1736ee022393d8609338ebec3addb604ad645b9b9268e36cf8c6",
                "md5": "39f4f30ffa8d45b3208f1ec360ea4c6b",
                "sha256": "9efd6ca2c1e5a9fc1ab70030f74f4a063f7e7ac065e6c7942d8b8cd08626accf"
            },
            "downloads": -1,
            "filename": "anansescanpy-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "39f4f30ffa8d45b3208f1ec360ea4c6b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">3.8",
            "size": 15436,
            "upload_time": "2023-01-12T10:53:50",
            "upload_time_iso_8601": "2023-01-12T10:53:50.160533Z",
            "url": "https://files.pythonhosted.org/packages/d3/5d/20b29cda1736ee022393d8609338ebec3addb604ad645b9b9268e36cf8c6/anansescanpy-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-12 10:53:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "Arts-of-coding",
    "github_project": "AnanseScanpy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "anansescanpy"
}
        
Elapsed time: 0.03460s