Giter VIP home page Giter VIP logo

navann's Introduction

1. Not Another Variant Annotator

Another variant annotator that leverages the ExAC server to annotate ones vcf.

Caveats

This has only been tested on FreeBayes output for two triploid samples.

It only works on the human genome assembley GR37 as that is all ExAC support. Also their version of VEP, which performs the annotations for the impact of the variant is rather outdated.

1.1. Getting Started

There isn't much required in terms of pre-requistes, besides an internet connection. The script does support the use of snpEff, however one must already have a local copy of the software installed. This can be found here https://pcingola.github.io/SnpEff

1.2. Install

clone the repo to your local machine cd into the directory of the cloned repo and install with: pip3 install . -r requirements.txt

1.3. Running the tests

Limited unit testing has been made for this code using a combination of the hypothesis library to perform property-based testing and Contracts.

Example command to run the test:

pytest /path_to_repo/src/tests

1.4. Built With

  • py3.8 - python
  • pandas - python library for data manipulation
  • hypothesis - python library for generating test data
  • dpcontracts - python library for setting contracts

1.5. Versioning

No verision software is used at this time

1.6. How to use

A simple tool to annotate one's vcf.

Example command to run the annotator script with all annotation functions:

navann --vcf ~/example/Challenge_data.vcf --verbose --outpath /path/to/outfolder/Challenge_data.ann.vcf --all

Run the annotator script, but output a csv with the fields of interest:

navann --vcf ~/example/Challenge_data.vcf --verbose --outpath /path/to/outfolder/Challenge_data.ann.vcf --all --simple_output /path/to/outfolder/Challenge_data.ann.csv

1.7. Authors

  • Andrei Rajkovic - Initial work

1.8. License

This project is licensed under the MIT License - see the LICENSE.md file for details

navann's People

Contributors

andreirajkovic avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.