snipgenie


Namesnipgenie JSON
Version 0.6.0 PyPI version JSON
download
home_pagehttps://github.com/dmnfarrell/snipgenie
Summaryvariant calling and phylogenies from microbial WGS data
upload_time2023-12-15 20:33:46
maintainer
docs_urlNone
authorDamien Farrell
requires_python
licenseGPL v3
keywords bioinformatics biology genomics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Background
----------

SNiPgenie is a tool for microbial variant calling and phylogenetic analysis from
raw read data. It was primarily written to be used with bacterial isolates of M. bovis
but can be applied to other species. You need a good quality reference genome to align to.

Dependencies
------------

* numpy
* pandas
* biopython
* matplotlib
* pyvcf
* pyfaidx
* bcbio_gff
* pyside2 (for gui only)

Other binaries required:

* bwa
* samtools
* bcftools
* tabix
* parallel

These binaries can be installed with apt in Ubuntu::

  sudo apt install bwa samtools bcftools tabix parallel

Installation
------------

From pypi::

  pip install snipgenie

From github::

  pip install -e git+https://github.com/dmnfarrell/snipgenie.git#egg=snipgenie

Usage
-----

Call with your own reference fasta file::

  snipgenie -r reference.fa -i data_files -o results

Use an in built species genome as reference. This will also supply an annotation file.
The current options are `Mbovis-AF212297, MTB-H37Rv, MAP-K10, M.smegmatis-MC2155`::

  snipgenie -S Mbovis-AF212297 -i data_files -o results


Provide more than one folder::

  snipgenie -r reference.fa -i data_files1 -i data_files2 -o results


Provide an annotation (genbank format) for consequence calling::

  snipgenie -r reference.fa -g reference.gb -i data_files -o results

Add your own filters and provide threads::

  snipgenie -r reference.fa -i data_files -t 8 -o results` \
  -f 'QUAL>=40 && INFO/DP>=20 && MQ>40'

Links
-----

* https://github.com/dmnfarrell/snipgenie
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dmnfarrell/snipgenie",
    "name": "snipgenie",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "bioinformatics,biology,genomics",
    "author": "Damien Farrell",
    "author_email": "farrell.damien@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/f1/5b/8f5ca64dc0c9107664fd6d775b07f013afe161199d09edeeb42e57a8d613/snipgenie-0.6.0.tar.gz",
    "platform": null,
    "description": "Background\n----------\n\nSNiPgenie is a tool for microbial variant calling and phylogenetic analysis from\nraw read data. It was primarily written to be used with bacterial isolates of M. bovis\nbut can be applied to other species. You need a good quality reference genome to align to.\n\nDependencies\n------------\n\n* numpy\n* pandas\n* biopython\n* matplotlib\n* pyvcf\n* pyfaidx\n* bcbio_gff\n* pyside2 (for gui only)\n\nOther binaries required:\n\n* bwa\n* samtools\n* bcftools\n* tabix\n* parallel\n\nThese binaries can be installed with apt in Ubuntu::\n\n  sudo apt install bwa samtools bcftools tabix parallel\n\nInstallation\n------------\n\nFrom pypi::\n\n  pip install snipgenie\n\nFrom github::\n\n  pip install -e git+https://github.com/dmnfarrell/snipgenie.git#egg=snipgenie\n\nUsage\n-----\n\nCall with your own reference fasta file::\n\n  snipgenie -r reference.fa -i data_files -o results\n\nUse an in built species genome as reference. This will also supply an annotation file.\nThe current options are `Mbovis-AF212297, MTB-H37Rv, MAP-K10, M.smegmatis-MC2155`::\n\n  snipgenie -S Mbovis-AF212297 -i data_files -o results\n\n\nProvide more than one folder::\n\n  snipgenie -r reference.fa -i data_files1 -i data_files2 -o results\n\n\nProvide an annotation (genbank format) for consequence calling::\n\n  snipgenie -r reference.fa -g reference.gb -i data_files -o results\n\nAdd your own filters and provide threads::\n\n  snipgenie -r reference.fa -i data_files -t 8 -o results` \\\n  -f 'QUAL>=40 && INFO/DP>=20 && MQ>40'\n\nLinks\n-----\n\n* https://github.com/dmnfarrell/snipgenie",
    "bugtrack_url": null,
    "license": "GPL v3",
    "summary": "variant calling and phylogenies from microbial WGS data",
    "version": "0.6.0",
    "project_urls": {
        "Homepage": "https://github.com/dmnfarrell/snipgenie"
    },
    "split_keywords": [
        "bioinformatics",
        "biology",
        "genomics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f15b8f5ca64dc0c9107664fd6d775b07f013afe161199d09edeeb42e57a8d613",
                "md5": "a5e76700e65ec7b6384ad91b4f8c6cc3",
                "sha256": "cfe864a73169d0bcc1ef908fed5066959146737038e7d60989e07d48de3ed710"
            },
            "downloads": -1,
            "filename": "snipgenie-0.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a5e76700e65ec7b6384ad91b4f8c6cc3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 32035079,
            "upload_time": "2023-12-15T20:33:46",
            "upload_time_iso_8601": "2023-12-15T20:33:46.220630Z",
            "url": "https://files.pythonhosted.org/packages/f1/5b/8f5ca64dc0c9107664fd6d775b07f013afe161199d09edeeb42e57a8d613/snipgenie-0.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-15 20:33:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dmnfarrell",
    "github_project": "snipgenie",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "snipgenie"
}
        
Elapsed time: 0.16601s