Broad-GenePy


NameBroad-GenePy JSON
Version 1.0 PyPI version JSON
download
home_pagehttps://github.com/BroadInstitute/GenePy
SummaryA useful module for any CompBio
upload_time2021-02-05 15:57:26
maintainer
docs_urlNone
authorJeremie Kalfon
requires_python>=3.5
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # GenePy

_what is [genepy](https://en.wikipedia.org/wiki/G%C3%A9n%C3%A9pi)?_

A set of awesome functions & tools for Computational Genomists

![long genome](documentation/genome.jpg)

## Content

- **utils**: where a bunch of helper functions and usefull general scripts are stoed
  - **plots**: a set of plotting tools based on [matplotlib]() and [bokeh]() to make volcano plots / CNV maps etc..
  - **helper**: and additional helper functions to save data, do merging of dataframes...
- **terra**: contains a set of functions that uses [dalmatian]() to interact with the [GCP]() powered genomics HPC platform: [Terra](). 
- **sequencing**: contains a set of function to works with bed/bam/fastqs...
- **rna**: contains function to work with RNAseq (and related) data.
  - **pyDESeq2**: it is a python integration of [deseq2]() (the differential expression analyser) with [rpy2]()
- **mutations**: a set of functions to work with maf files, vcf files etc..
- **google**: functions and packages linked to google's apis
  - **google_sheet**: function to upload a df as a google sheet
  - **gcp**: sets of functions to interact with google storage (relies on gsutil)
- **epigenetics**: where we have things related to epigenomics
  - **chipseq**: has functions to read, merge, denoise, ChIP seq data, it contains a lot of functions required for the AML paper.

### Helper tools

_tools that you do not need to use directly as they have binding functions in GenePy._ 

- **epigenetics/rose:**: where an updated version of the rose algorithm is stored (as a git submodule) 
- **cell_line_mapping**: a set of functions to map cell line ids to other cell line ids based on an up to date google spreadsheet. 


## Install

### with pip (WIP)

`pip install GenePy`
### dev mode (better for now)

```bash
git clone git://github.com/BroadInstitute/GenePy.git
cd GenePy
git submodule update --init
```

then you can import files in python with e.g:
```python
from GenePy import TerraFunction as terra
```

if GenePy is not in your path, first do:

```python
import sys
sys.path.append(RELATIVE_PATH_TO_GenePy)
```

now you can install the necessary python packages:

```bash
pip install requirements.txt
pip install rpy2-bioconductor-extensions gseapy macs2 deeptools
```

or if not using the requirements.txt (computation results might change):

```bash
pip install numpy pandas
```

```bash
pip install bokeh dalmatian firecloud_dalmatian google_api_python_client gsheets gspread ipdb ipython matplotlib Pillow pybedtools pyBigWig pysam pytest requests rpy2 scikit_learn scipy seaborn setuptools taigapy taigapy typing venn rpy2-bioconductor-extensions gseapy macs2 deeptools
```

then install the following tools:
- [htslib/samtools](http://www.htslib.org/)
- [bwa](https://github.com/lh3/bwa)
just used once:
- [bowtie2](http://bowtie-bio.sourceforge.net/bowtie2/index.shtml)

finaly you can install R packages (GSEABase, erccdashboard, GSVA, DESeq2):

```bash
R -e 'if(!requireNamespace("BiocManager", quietly = TRUE)){install.packages("BiocManager")};BiocManager::install(c("GSEABase", "erccdashboard", "GSVA", "DESeq2"));'
```
## About

please do contribute, we do not have time to fix all issues or work on feature requests

Jeremie Kalfon jkalfon@broadinstitute.org jkobject@gmail.com https://jkobject.com



Apache license 2.0.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/BroadInstitute/GenePy",
    "name": "Broad-GenePy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5",
    "maintainer_email": "",
    "keywords": "",
    "author": "Jeremie Kalfon",
    "author_email": "jkobject@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/19/c5/0ad2b6d5e0afc315261d9eed6b21832b0311b3107e141392ccb3b1ff78a6/Broad-GenePy-1.0.tar.gz",
    "platform": "",
    "description": "# GenePy\n\n_what is [genepy](https://en.wikipedia.org/wiki/G%C3%A9n%C3%A9pi)?_\n\nA set of awesome functions & tools for Computational Genomists\n\n![long genome](documentation/genome.jpg)\n\n## Content\n\n- **utils**: where a bunch of helper functions and usefull general scripts are stoed\n  - **plots**: a set of plotting tools based on [matplotlib]() and [bokeh]() to make volcano plots / CNV maps etc..\n  - **helper**: and additional helper functions to save data, do merging of dataframes...\n- **terra**: contains a set of functions that uses [dalmatian]() to interact with the [GCP]() powered genomics HPC platform: [Terra](). \n- **sequencing**: contains a set of function to works with bed/bam/fastqs...\n- **rna**: contains function to work with RNAseq (and related) data.\n  - **pyDESeq2**: it is a python integration of [deseq2]() (the differential expression analyser) with [rpy2]()\n- **mutations**: a set of functions to work with maf files, vcf files etc..\n- **google**: functions and packages linked to google's apis\n  - **google_sheet**: function to upload a df as a google sheet\n  - **gcp**: sets of functions to interact with google storage (relies on gsutil)\n- **epigenetics**: where we have things related to epigenomics\n  - **chipseq**: has functions to read, merge, denoise, ChIP seq data, it contains a lot of functions required for the AML paper.\n\n### Helper tools\n\n_tools that you do not need to use directly as they have binding functions in GenePy._ \n\n- **epigenetics/rose:**: where an updated version of the rose algorithm is stored (as a git submodule) \n- **cell_line_mapping**: a set of functions to map cell line ids to other cell line ids based on an up to date google spreadsheet. \n\n\n## Install\n\n### with pip (WIP)\n\n`pip install GenePy`\n### dev mode (better for now)\n\n```bash\ngit clone git://github.com/BroadInstitute/GenePy.git\ncd GenePy\ngit submodule update --init\n```\n\nthen you can import files in python with e.g:\n```python\nfrom GenePy import TerraFunction as terra\n```\n\nif GenePy is not in your path, first do:\n\n```python\nimport sys\nsys.path.append(RELATIVE_PATH_TO_GenePy)\n```\n\nnow you can install the necessary python packages:\n\n```bash\npip install requirements.txt\npip install rpy2-bioconductor-extensions gseapy macs2 deeptools\n```\n\nor if not using the requirements.txt (computation results might change):\n\n```bash\npip install numpy pandas\n```\n\n```bash\npip install bokeh dalmatian firecloud_dalmatian google_api_python_client gsheets gspread ipdb ipython matplotlib Pillow pybedtools pyBigWig pysam pytest requests rpy2 scikit_learn scipy seaborn setuptools taigapy taigapy typing venn rpy2-bioconductor-extensions gseapy macs2 deeptools\n```\n\nthen install the following tools:\n- [htslib/samtools](http://www.htslib.org/)\n- [bwa](https://github.com/lh3/bwa)\njust used once:\n- [bowtie2](http://bowtie-bio.sourceforge.net/bowtie2/index.shtml)\n\nfinaly you can install R packages (GSEABase, erccdashboard, GSVA, DESeq2):\n\n```bash\nR -e 'if(!requireNamespace(\"BiocManager\", quietly = TRUE)){install.packages(\"BiocManager\")};BiocManager::install(c(\"GSEABase\", \"erccdashboard\", \"GSVA\", \"DESeq2\"));'\n```\n## About\n\nplease do contribute, we do not have time to fix all issues or work on feature requests\n\nJeremie Kalfon jkalfon@broadinstitute.org jkobject@gmail.com https://jkobject.com\n\n\n\nApache license 2.0.",
    "bugtrack_url": null,
    "license": "",
    "summary": "A useful module for any CompBio",
    "version": "1.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c872ff711966ca9a748cb496b0a5fdc1",
                "sha256": "e704b5b7615b9ea8692d84b6064e6b6c6b9a37335b11e7d93350129b2db6d511"
            },
            "downloads": -1,
            "filename": "Broad-GenePy-1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c872ff711966ca9a748cb496b0a5fdc1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 3443,
            "upload_time": "2021-02-05T15:57:26",
            "upload_time_iso_8601": "2021-02-05T15:57:26.712341Z",
            "url": "https://files.pythonhosted.org/packages/19/c5/0ad2b6d5e0afc315261d9eed6b21832b0311b3107e141392ccb3b1ff78a6/Broad-GenePy-1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-02-05 15:57:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "BroadInstitute",
    "error": "Could not fetch GitHub repository",
    "lcname": "broad-genepy"
}
        
Elapsed time: 0.20822s