{ "info": { "author": "Zhemin Zhou", "author_email": "zhemin.zhou@warwick.ac.uk", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7" ], "description": "# Strain Prediction and Analysis using Representative SEquences (SPARSE)\n\nSPARSE indexes >100,000 reference genomes in public databases in to hierarchical clusters and uses it to predict origins of metagenomic reads. \n\n\n[![Build Status](https://travis-ci.org/zheminzhou/SPARSE.svg?branch=master)](https://travis-ci.org/zheminzhou/SPARSE)\n[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![Docs Status](https://readthedocs.org/projects/sparse/badge/)](http://sparse.readthedocs.io/en/latest/)\n\n## Installation \n\nSPARSE runs on Unix and requires Python version 2.7 (Python 3.x supports are under development)\n\n**System modules (Ubuntu 16.04) :**\n\n* pip\n* gfortran\n* llvm\n* libncurses5-dev\n* cmake\n* xvfb-run (for malt, optional)\n\n**3rd-party software:**\n* samtools (>=1.2)\n* mash (>=1.1.1)\n* bowtie2 (>=2.3.2)\n* malt (>=0.4.0) (optional)\n\nSee [requirements.txt](requirements.txt) for python module dependencies. \n\n### Installation via PIP [Suggested]\n\n pip install meta-sparse\n\n### Installation from source codes (Ubuntu) \n \n sudo apt-get update\n sudo apt-get install gfortran llvm libncurses5-dev cmake python-pip samtools bowtie2\n git clone https://github.com/zheminzhou/SPARSE\n cd SPARSE/EM && make\n pip install -r requirements.txt \n \n\n### Updating SPARSE\nYou can update to latest version using PIP:\n```\npip install --upgrade meta-sparse\n```\nIf you installed SPARSE from github, move to installation directory and pull the latest version: \n\n cd SPARSE\n git pull\n \n \n## Quick Start\nSee http://sparse.readthedocs.io/en/latest/ for full documentation.\n\n1. **Download reference database**\n\nWe provide a pre-compiled database based on RefSeq (dated 19.05.2018) to download at http://enterobase.warwick.ac.uk/sparse/refseq_20180519.tar.gz\n. The database can be downloaded and unpacked by running:\n ```\n curl -o refseq_20180519.tar.gz http://enterobase.warwick.ac.uk/sparse/refseq_20180519.tar.gz\n tar -vxzf refseq_20180519.tar.gz\n ```\n \n This pre-compiled database is about 350GB and contains four default mapping databases, which can be specified in the next step: representative, subpopulation, Virus, Eukaryota.\n \n To update the database or build a costum database, please refer to the full documentation.\n \n2. **Predict read origins**\n\nThis following command will map and evaluate all reads in both fastq-files against the specified mapping databases. \n```\nsparse predict --dbname refseq_20180519 --mapDB representative,subpopulation,Virus,Eukaryota --r1 read1.fq.gz --r2 read2.fq.gz --workspace \n```\nFor single-end reads, only --r1 needs to be specified. All output files are stored in the respective workspace.\n\n3. **Create a report**\n```\nsparse report \n```\nThe report will be stored in /profile.txt\n\n4. **Extract reference specific reads**\n\nThe following command extracts all reads specific to the provided reference ids, which can be found in the output of step 2.\n```\nsparse extract --dbname refseq_20171014 --workspace --ref_id \n```\n\n\n\n## Citation\nSPARSE is published as a conference proceeding in \"Research in Computational Molecular Biology\".\n\nZhemin Zhou, Nina Luhmann, Nabil-Fareed Alikhan, Christopher Quince, Mark Achtman, 'Accurate Reconstruction of Microbial Strains from Metagenomic Sequencing Using Representative Reference Genomes' RECOMB 2018: Research in Computational Molecular Biology pp 225-240. doi: https://doi.org/10.1007/978-3-319-89929-9_15\n\nA preprint version of the manuscript is also accessible in bioRxiv: https://doi.org/10.1101/215707", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/zheminzhou/SPARSE/", "keywords": "bioinformatics,microbial,metagenomics", "license": "", "maintainer": "", "maintainer_email": "", "name": "meta-sparse", "package_url": "https://pypi.org/project/meta-sparse/", "platform": "", "project_url": "https://pypi.org/project/meta-sparse/", "project_urls": { "Bug Reports": "https://github.com/zheminzhou/SPARSE/issues", "Homepage": "https://github.com/zheminzhou/SPARSE/", "Source": "https://github.com/zheminzhou/SPARSE/" }, "release_url": "https://pypi.org/project/meta-sparse/0.1.12/", "requires_dist": null, "requires_python": "", "summary": "SPARSE indexes reference genomes in public databases into hierarchical clusters and uses it to predict origins of metagenomic reads.", "version": "0.1.12" }, "last_serial": 4624808, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "4783ef5f9e8074f24f1a1abd17de71d0", "sha256": "479546e5cf9c84e444a04b41ef9b3f5ed9c67f499074ec2bdf352aa44c6ca47f" }, "downloads": -1, "filename": "meta-sparse-0.1.0.tar.gz", "has_sig": false, "md5_digest": "4783ef5f9e8074f24f1a1abd17de71d0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6449572, "upload_time": "2018-04-16T17:06:01", "url": "https://files.pythonhosted.org/packages/a1/21/a4efadf90bc83186966e0c365cbf10250bbd3c5d13ba4b456d34de9829e0/meta-sparse-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "2ec63df0fb3f46bf23f0e0ef273b872e", "sha256": "2f4fbe9e5ba20c821603f60123d1e4167001daa5a7f0479b4fb959b9a6870a6d" }, "downloads": -1, "filename": "meta-sparse-0.1.1.tar.gz", "has_sig": false, "md5_digest": "2ec63df0fb3f46bf23f0e0ef273b872e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24348166, "upload_time": "2018-04-17T16:32:32", "url": "https://files.pythonhosted.org/packages/22/a2/940520cd405daef10e2d72ff74348ca1d0e8aab39497164cb6a835f1dd2a/meta-sparse-0.1.1.tar.gz" } ], "0.1.10": [ { "comment_text": "", "digests": { "md5": "a086e31c45b82781dbded79fa158cd20", "sha256": "5b8dbb721b336c70e8bfe3fc4134f5f717087efdf2000415518bbe2eff4e44d3" }, "downloads": -1, "filename": "meta-sparse-0.1.10.tar.gz", "has_sig": false, "md5_digest": "a086e31c45b82781dbded79fa158cd20", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27552667, "upload_time": "2018-07-18T15:55:05", "url": "https://files.pythonhosted.org/packages/ed/2c/caea4b418f2d5224efb11a20636b6301de716c67f5b5bd16476b3149ede6/meta-sparse-0.1.10.tar.gz" } ], "0.1.11": [ { "comment_text": "", "digests": { "md5": "b997291ac82e6be7674fce1b92c19172", "sha256": "120ea1c261ca740fd7383502f293d7b449f666f791d2029c54a4da9e2f7f4da1" }, "downloads": -1, "filename": "meta-sparse-0.1.11.tar.gz", "has_sig": false, "md5_digest": "b997291ac82e6be7674fce1b92c19172", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27552818, "upload_time": "2018-07-18T17:14:05", "url": "https://files.pythonhosted.org/packages/81/fd/ed7a13bb0ce85adab65eece9741bc377b527dca5f5ce033e69d1eabbda5d/meta-sparse-0.1.11.tar.gz" } ], "0.1.12": [ { "comment_text": "", "digests": { "md5": "ebd8687ae8ad11543f4ba3609b613447", "sha256": "6d5275c499a3b14ab4cd477f9ec4ba0744a38764a81342ef87c6c0199fb83580" }, "downloads": -1, "filename": "meta-sparse-0.1.12.tar.gz", "has_sig": false, "md5_digest": "ebd8687ae8ad11543f4ba3609b613447", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27538797, "upload_time": "2018-12-21T12:05:08", "url": "https://files.pythonhosted.org/packages/ff/d6/2d8f4caac92bc100859cf0725649fbbbb6822cfe346944b595665bbf4c71/meta-sparse-0.1.12.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "45d5318465363740ae0873265b4b4056", "sha256": "644576a698551f5c7bc09de9a04929790b94f4fa4e52ef84358fb8ca5be68c3a" }, "downloads": -1, "filename": "meta-sparse-0.1.2.tar.gz", "has_sig": false, "md5_digest": "45d5318465363740ae0873265b4b4056", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27182131, "upload_time": "2018-04-18T08:41:20", "url": "https://files.pythonhosted.org/packages/dc/40/fa1652a2470889411c51cd295228434d55db14704e8d0f46bb661830822b/meta-sparse-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "d536c9ef33a53da4ad97a30e8797d68f", "sha256": "8e3ed8accf4470f4838efef3952bdcf3d898d2a29cbb282a265540a6644b29e1" }, "downloads": -1, "filename": "meta-sparse-0.1.3.tar.gz", "has_sig": false, "md5_digest": "d536c9ef33a53da4ad97a30e8797d68f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27549582, "upload_time": "2018-05-23T13:14:41", "url": "https://files.pythonhosted.org/packages/5a/42/82372a81e540f30742831e55fda75a3784165b119a470315af9ffcc4ad43/meta-sparse-0.1.3.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "d4288cb62908d69d3e25a9b72d1bc60c", "sha256": "bdf78d9fa1d8cb77a19f0c3048a6dbfecf27cb48a55f19dcfb1d460ad14dbca8" }, "downloads": -1, "filename": "meta-sparse-0.1.5.tar.gz", "has_sig": false, "md5_digest": "d4288cb62908d69d3e25a9b72d1bc60c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27549833, "upload_time": "2018-05-27T13:37:39", "url": "https://files.pythonhosted.org/packages/75/bf/725c5cb2de280ff6bc464ca96e92b1aafdc40d1cfaceb7d327548f6c9ed3/meta-sparse-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "fd2b591789070a19d1e2c321b60fe40c", "sha256": "fb5d2cb066f0adba5908d3aa510345a102563584749767de50687d6423396634" }, "downloads": -1, "filename": "meta-sparse-0.1.6.tar.gz", "has_sig": false, "md5_digest": "fd2b591789070a19d1e2c321b60fe40c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27549952, "upload_time": "2018-06-26T21:49:26", "url": "https://files.pythonhosted.org/packages/89/d4/b3a1d949f8ad13caddd169f1dc2a1ad1a74ec0f41055991e4f846203232f/meta-sparse-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "59bb61c210ec681901f3c8b7e8bbe05b", "sha256": "805a63c0fbc1745b35e5e34a2eb2ba167657a4119ba247509047ec208e33d4e6" }, "downloads": -1, "filename": "meta-sparse-0.1.7.tar.gz", "has_sig": false, "md5_digest": "59bb61c210ec681901f3c8b7e8bbe05b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27549911, "upload_time": "2018-06-27T00:16:10", "url": "https://files.pythonhosted.org/packages/ba/47/53648fdc8451dd8d428f783f2e734c5dcda148bb86e7d544843afb95e8ae/meta-sparse-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "165fdb7c0bf0c5f51c4101b630cb8bf3", "sha256": "b233383852455720db05aa5e37bf44b76d315a9bd7dc9874578fe91b044b6ce3" }, "downloads": -1, "filename": "meta-sparse-0.1.8.tar.gz", "has_sig": false, "md5_digest": "165fdb7c0bf0c5f51c4101b630cb8bf3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27552447, "upload_time": "2018-07-06T18:17:41", "url": "https://files.pythonhosted.org/packages/86/a2/fadf5a5f0b17b60fa0105da03a6d8f55e0c09dc1bcd877df6589ad97f6bc/meta-sparse-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "f505103f1fe12a9648b9757109fdb6c4", "sha256": "403105517cea736704ddf61a45985f5137df85354a780e96db4b61eb413642a3" }, "downloads": -1, "filename": "meta-sparse-0.1.9.tar.gz", "has_sig": false, "md5_digest": "f505103f1fe12a9648b9757109fdb6c4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27552487, "upload_time": "2018-07-13T14:46:50", "url": "https://files.pythonhosted.org/packages/7d/73/5e3a73e3442a2d055dd04441ad0aad77d228799b98ed7adec95a9aeba3e6/meta-sparse-0.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ebd8687ae8ad11543f4ba3609b613447", "sha256": "6d5275c499a3b14ab4cd477f9ec4ba0744a38764a81342ef87c6c0199fb83580" }, "downloads": -1, "filename": "meta-sparse-0.1.12.tar.gz", "has_sig": false, "md5_digest": "ebd8687ae8ad11543f4ba3609b613447", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 27538797, "upload_time": "2018-12-21T12:05:08", "url": "https://files.pythonhosted.org/packages/ff/d6/2d8f4caac92bc100859cf0725649fbbbb6822cfe346944b595665bbf4c71/meta-sparse-0.1.12.tar.gz" } ] }