{ "info": { "author": "Laurent Gautier", "author_email": "lgautier@gmail.com", "bugtrack_url": null, "classifiers": [ "Programming Language :: Python", "Programming Language :: Python :: 3" ], "description": "# About\n\nThis code is supplementary material for the peer-reviewed publication:\n\nhttp://journals.plos.org/plosone/article?id=10.1371/journal.pone.0083784\n\n(also in [GenomeWeb](https://www.genomeweb.com/sequencing/danish-duo-introduces-microbe-identification-scheme-based-random-subset-raw-sequ))\n\n\nIt requires:\n\n- Python >= 3.3+ (currently tested with Python 3.5)\n\n- `bowtie2` in the PATH (parameter `-a`, try `--help`)\n\n- It is self-documented (try `-h` or `--help`).\n\nIt is working on FASTQ or gzipped-FASTQ files, possibly on BAM files.\n\nBe gentle and please do not hammer the server like there is no tomorrow.\n\nThe latest released versions of the package will always be on Pypi.\n\nThe terminal-based UI is looking like this:\n\n![Screenshot](screenshot.png)\n\n\nThe code is shipping with test data:\n\n- Phage Lambda DNA sequence from ftp://ftp.ncbi.nlm.nih.gov/genomes/all/GCF/000/840/245/GCF_000840245.1_ViralProj14204\n \n\n# Installation\n\nThis installs as a regular Python package with:\n\n```bash\n\t \npython setup.py install\n\n```\n\nIt is also available in a Docker container. The current release is version 0.3.0.\n\n```bash\n\ndocker pull lgautier/dnasnout-client:0.3.0\n\n```\n\n**Note about the docker image:** the default user is called `docker_user`,\nso the container is not running an in-container root. We are providing\na way to map the in-container user to the host user below, making\nthe execution of the software as an in-container command line\na practical option.\n\n \n# Usage\n\n\n```bash\n\nalias dnasnout=\"python -m dnasnout_client.console\"\n\n```\n\nDeclaring an alias that runs a container from our Docker image\nthat can access the current working directory with the host's user and group ID\ncan be done with:\n\n```bash\nalias dnasnout=\"docker run \\\n --rm -t \\\n -v `pwd`:/shared \\\n -u $(id -u):$(id -g) \\\n -w /shared \\\n lgautier/dnasnout-client:0.3.0 \\\n python3 -m dnasnout_client.console\"\n\n```\n\nOnce the alias is declared, we can use it as a regular command:\n\n```bash\n\nwget http://tapir.cbs.dtu.dk/static/iontorrent_head400.fq\ndnasnout -i iontorrent_head400.fq -d iontorrent_test\n\n```\n\nA more difficult dataset is a metagenome sample from anterior nares in\nthe HMP Core Microbiome Sampling Protocol A (HMP-A).\n\nWe use read data available on the CloVR website: http://data.clovr.org/\n\n```bash\n\nwget http://clovr.org/files/Diginorm_sample_input.zip\nunzip Diginorm_sample_input.zip\n\ndnasnout -i Diginorm_sample_input/SRS018671.denovo_duplicates_marked.trimmed.1.fastq \\\n -d diginorm_test \\\n\t -n 600 --bloom-filter --seed 123 --n-matches=8\n\n```\n\nUnsurprising results are:\n\n- /Staphilococcus epidermidis/ is found\n- possible human (not suprising) or mouse DNA (probable artefact from our sample strategy that alignment would clear up)\n\nUnfortunately, the human and mouse references genomes are not downloaded\n(our server is geared toward serving larger genomes) but the general idea is that one would\nfirst align the reads in such samples against the human (or mouse) genome and use dnasnout\non the unmapped reads.\n\nMore surprising results are unplaced genomic scaffold from:\n\n- /Harpegnathos saltator/\n- /Volvox carteri f. nagariensis/\n\nThese are either artefacts from our scoring, from the reference sequence (contamination\nwhen the references where sequenced).\n\n\n\nHelp is available with:\n\n```bash\n\ndnasnout --help\n\n```\n\n**note:** To update the Docker image to the latest version, `docker pull` is required each time\n(otherwise Docker will use the local image available).\n\n```bash\n\ndocker pull lgautier/dnasnout-client:latest\n\n```\n\n\n", "description_content_type": null, "docs_url": "https://pythonhosted.org/dnasnout-client/", "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/lgautier/dnasnout-client", "keywords": "", "license": "This software is available under a dual license model: the AGPLv3 or a commercial license. If you need a commercial license, contact the author.", "maintainer": "", "maintainer_email": "", "name": "dnasnout-client", "package_url": "https://pypi.org/project/dnasnout-client/", "platform": "", "project_url": "https://pypi.org/project/dnasnout-client/", "project_urls": { "Homepage": "https://bitbucket.org/lgautier/dnasnout-client" }, "release_url": "https://pypi.org/project/dnasnout-client/0.3.1/", "requires_dist": null, "requires_python": "", "summary": "DNASnout client", "version": "0.3.1" }, "last_serial": 2527416, "releases": { "0.0.5-c7b30905ec1b": [ { "comment_text": "", "digests": { "md5": "40193740a624d8bc928e95b18c24ab6a", "sha256": "10e9c5d8465e7f6029002a490190d3f7a595082fdd5daa61b12a4c65f936e0e9" }, "downloads": -1, "filename": "dnasnout-client-0.0.5-c7b30905ec1b.tar.gz", "has_sig": false, "md5_digest": "40193740a624d8bc928e95b18c24ab6a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20626, "upload_time": "2013-06-07T18:37:37", "url": "https://files.pythonhosted.org/packages/ac/bf/851452fe270dc859f69510bc5ee7699ca2e8fdd06def58a1d4afa8f5cecb/dnasnout-client-0.0.5-c7b30905ec1b.tar.gz" } ], "0.1.0-4da047477130": [ { "comment_text": "", "digests": { "md5": "5569bfc3205887ed935f389502766fe2", "sha256": "5014d4a472e921504ee9aaaeeefcae49cb2a1154e68b92d03d3327311c5df2d7" }, "downloads": -1, "filename": "dnasnout-client-0.1.0-4da047477130.tar.gz", "has_sig": false, "md5_digest": "5569bfc3205887ed935f389502766fe2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20874, "upload_time": "2013-07-02T09:11:08", "url": "https://files.pythonhosted.org/packages/ce/6d/8f6846c2b563530879cb713d11bdb29526c2f49226b17deef52c0769b4aa/dnasnout-client-0.1.0-4da047477130.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "c40e966209b1aa9d31a6336f90667171", "sha256": "0935a08f6ee17596fede43ac3271324e7730f0b95f7ff5f2729585758b435c51" }, "downloads": -1, "filename": "dnasnout-client-0.2.0.tar.gz", "has_sig": false, "md5_digest": "c40e966209b1aa9d31a6336f90667171", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 23972, "upload_time": "2014-04-12T18:38:57", "url": "https://files.pythonhosted.org/packages/e0/57/99f7e703f665c06d1bb56d82108b5a099df32668b6c57793d23b96b8b02d/dnasnout-client-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "3c0366308fb508ab5f305130bfabeabe", "sha256": "a445e9ec8aae4a14fa4cf06378f65cc56f6af310273458e3982f8c386c0602ff" }, "downloads": -1, "filename": "dnasnout-client-0.3.0.tar.gz", "has_sig": false, "md5_digest": "3c0366308fb508ab5f305130bfabeabe", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41846, "upload_time": "2016-12-04T17:26:36", "url": "https://files.pythonhosted.org/packages/3e/0d/be7b801a76469c2586eba46e538e2bf41207b6de7617ea89fb8dedfb511e/dnasnout-client-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "c3570f47766a25466654b4ad68411719", "sha256": "cad3ac8baa9c3294f7c207e96d56997291c2a99de112d3e4c7dc83d28b202df6" }, "downloads": -1, "filename": "dnasnout-client-0.3.1.tar.gz", "has_sig": false, "md5_digest": "c3570f47766a25466654b4ad68411719", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41864, "upload_time": "2016-12-19T03:49:31", "url": "https://files.pythonhosted.org/packages/bf/53/c3b5c95cadf27cabb2a95bc32757a6a00cbb5dde925d5466c82cf91f79c3/dnasnout-client-0.3.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c3570f47766a25466654b4ad68411719", "sha256": "cad3ac8baa9c3294f7c207e96d56997291c2a99de112d3e4c7dc83d28b202df6" }, "downloads": -1, "filename": "dnasnout-client-0.3.1.tar.gz", "has_sig": false, "md5_digest": "c3570f47766a25466654b4ad68411719", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 41864, "upload_time": "2016-12-19T03:49:31", "url": "https://files.pythonhosted.org/packages/bf/53/c3b5c95cadf27cabb2a95bc32757a6a00cbb5dde925d5466c82cf91f79c3/dnasnout-client-0.3.1.tar.gz" } ] }