{
"info": {
"author": "Xiao Li",
"author_email": "xiaoli@broadinstitute.org",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: MIT License",
"Natural Language :: English",
"Programming Language :: Python :: 3.4",
"Topic :: Scientific/Engineering :: Bio-Informatics"
],
"description": "# FunPipe: a python library for building best practice fungal genomic analysis pipeline\n\n`FunPipe` is a python library designed for efficient implementation of bioinformatic tools and pipelines for fungal genomic analysis. It contains wrapper functions to popular tools, customized functions for specific analyses tasks, and command line tools developed using those functions. This package is developing to facilitate fungal genomics, but many of the functions are generally applicable to other genomic analysis as well.\n\n## Requirements\n* Python >= 3.7\n* Bioinformatic tool collections: can be automatically installed via conda [here](#CONDA)\n * Basic functions:\n - samtools>=1.9\n - bwa>=0.7.8\n - gatk>=3.8\n - picard>=2.18.17\n * Phylogenetics:\n - raxml>=8.2.12\n - readseq>=2.1.30\n * CNV:\n - breakdancer>=1.4.5\n - cnvator>=0.3\n - covisr>=0.1\n * Microbiome:\n - pilon>=1.23\n - diamond>=0.9.22\n\nThe above list of bioinformatic tools need to be properly installed and add to `PATH`. Path to Java tools (JARs) need to be specified when evocaking specific functions.\n\n### Installation\n**Install with Conda**\nIt is recommended to install funpipe via conda, as it automatically setup all required bioinformatic tools. This is extremely useful on servers or\nclusters without root privilage. Make sure `conda` is available in your environment via `which conda`. If `conda` is not available in your system, install Python3.7 version of it [here](https://conda.io/miniconda.html).\n\nHTTP errors sometimes occur when creating the conda environment, simply rerun the `conda env create -f conda_env.yml` to continue creating the environment.\n\n```sh\n# clone this repo\ngit clone git@github.com:broadinstitute/funpipe.git\n\n# setup conda environment\ncd funpipe\n\nconda env create -f conda_env.yml # this will take about 10 min\nconda list # verify new environment was installed correctly\n\n# activate funpipe environment\nconda activate funpipe\n\n# the latest stable version of funpipe is available in this environment\n# to use the latest funpipe version, do\npip install .\n\n# deactivate the environment when done\nconda deactivate\n\n# completely remove the virtual environment\nconda remove -name funpipe --all\n```\nNote:\n* `diamond=0.9.22` uses boost library, which depends on `python 2.7`. This conflicts with funpipe's python version. To use diamond, use it via [docker](#DOCKER).\n\n\n**Install with PIP**\nPIP can be used to install funpipe.\n```sh\n# install latest stable release\npip install funpipe\n\n# install a specific version\npip install funpipe==0.1.0\n```\n\nTo install the latest version: funpipe\n```sh\ngit clone git@github.com:broadinstitute/funpipe.git\ncd funpipe\npip install .\n```\n\n**Install via Docker**\n\nThere's a bit more overhead using Docker, but it came along with the benefits of consistent environment (i.e.: including the operation systems). It's very useful when using `funpipe` on the cloud.\n\nTo use docker:\n```\n# Download docker\ndocker pull broadinstitute/funpipe:latest\n\n# Run analysis interactively\ndocker run --rm -v $path_to_data/data -t broadinstitute/funpipe \\\n /bin/bash -c \"/scripts/vcf_qc_metr.py \\\n -p prefix --jar /bin/GenomeAnalysisTK.jar \\\n --fa /data/reference.fa\n \"\n```\n\nYou can use `Dockerfile` to compile the docker from scratch:\n```sh\ncd funpipe\ndocker build funpipe .\n```\n\n### Synposis\n* [funpipe](./funpipe): a directory that contains python library\n* [scripts](./scripts): a set of executables for high level analysis\n* [tests](./tests): module tests\n* [docs](./docs): documentation\n* `setup.py`: pip setup script\n* `conda_env.yml`: spec file for setting up conda environment\n* `Dockerfile`: docker images\n\n### Documentation\nMajor analysis pipelines:\n- Quality control modules\n - Reference genome quality evaluation with `Pilon`.\n - FASTQ quality control with `fastqc`.\n - BAM quality control using `Picard`.\n - VCF quality control using `GATK VariantEval`.\n- Variant Annotation with `snpEff`.\n- Genomic Variation\n - Coverage analysis\n - Mating type analysis\n - Copy number variation with `CNVnator`\n - Structural variant analysis with `breakdancer`\n- Phylogenetic analysis\n - Dating analysis with `BEAST`.\n - Phylogenetic tree with `FastTree`, `RAxML` and `IQTREE`.\n- GWAS analysis with `GEMMA`.\n\nHere are scripts to run each of the above pipelines, use ` -h` to see manual.\n```sh\n##### Quality control #####\nrun_pilon.py # Evaluate reference genome quality with pilon\nfastqc.py # Fastq quality control\nbam_qc_metr.py # Quality control of BAMs\nvcf_qc_metr.py # Quality control of VCFs\n\n##### Variant Annotation #####\nrun_snpeff.py # Annotation genomic variants with snpEff\nphylo_analysis.py # Phylogenetic analysis\n\n##### Genomic Variations #####\ncoverage_analysis.py # Hybrid coverage and ploidy analysis\n\n```\nYou can also use out APIs to build your customized analysis scripts or pipelines. Checkout documents at: https://funpipe.readthedocs.io\n\n\n",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/broadinstitute/funpipe",
"keywords": "bioinformatics",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "funpipe",
"package_url": "https://pypi.org/project/funpipe/",
"platform": "",
"project_url": "https://pypi.org/project/funpipe/",
"project_urls": {
"Bug tracker": "https://github.com/broadinstitute/funpipe/issues",
"Documentation": "https://github.com/broadinstitute/funpipe/README.md",
"Homepage": "https://github.com/broadinstitute/funpipe"
},
"release_url": "https://pypi.org/project/funpipe/0.1.0/",
"requires_dist": [
"argparse (>=1.1)",
"crimson (>=0.4.0)",
"pandas (>=0.23.4)",
"matplotlib (>=3.0.2)",
"seaborn (>=0.9.0)"
],
"requires_python": "",
"summary": "A pipeline for analyzing fungal genomic data",
"version": "0.1.0"
},
"last_serial": 5082129,
"releases": {
"0.1.0": [
{
"comment_text": "",
"digests": {
"md5": "9128ff59df3b86eb2c9db3b4cf4d9464",
"sha256": "77fe1eb70f95028de962178f4335e2ea5de8f76800e68cdcb31f7c275d1f00e0"
},
"downloads": -1,
"filename": "funpipe-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9128ff59df3b86eb2c9db3b4cf4d9464",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 75569,
"upload_time": "2019-04-03T04:05:40",
"url": "https://files.pythonhosted.org/packages/f1/d6/4ff62aab1295e3600e36f2bad3cceb1bc8ad94a7a83d4e6df9b9bde55f9a/funpipe-0.1.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "ea4b3255ed2e67ef0e5ab41be18ffc10",
"sha256": "fd411ba0d6e087241a43630f6f7e2e8c8fba20051eb956490145afdddfe60a90"
},
"downloads": -1,
"filename": "funpipe-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ea4b3255ed2e67ef0e5ab41be18ffc10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39197,
"upload_time": "2019-04-03T04:05:42",
"url": "https://files.pythonhosted.org/packages/79/50/7ea92698fb48400015fbf1ca253a6f993adde1a05228c3c414668c4afeb4/funpipe-0.1.0.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "9128ff59df3b86eb2c9db3b4cf4d9464",
"sha256": "77fe1eb70f95028de962178f4335e2ea5de8f76800e68cdcb31f7c275d1f00e0"
},
"downloads": -1,
"filename": "funpipe-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9128ff59df3b86eb2c9db3b4cf4d9464",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 75569,
"upload_time": "2019-04-03T04:05:40",
"url": "https://files.pythonhosted.org/packages/f1/d6/4ff62aab1295e3600e36f2bad3cceb1bc8ad94a7a83d4e6df9b9bde55f9a/funpipe-0.1.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "ea4b3255ed2e67ef0e5ab41be18ffc10",
"sha256": "fd411ba0d6e087241a43630f6f7e2e8c8fba20051eb956490145afdddfe60a90"
},
"downloads": -1,
"filename": "funpipe-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ea4b3255ed2e67ef0e5ab41be18ffc10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39197,
"upload_time": "2019-04-03T04:05:42",
"url": "https://files.pythonhosted.org/packages/79/50/7ea92698fb48400015fbf1ca253a6f993adde1a05228c3c414668c4afeb4/funpipe-0.1.0.tar.gz"
}
]
}