search

0m0kenny / sprint2

ENSEMBL SPRINT 2
MIT License
0 stars 0 forks source link

readme

Variant_Annotator

Build Status

codecov

About

variant_annotator is a software tool that returns predicted effects of a variant on genes, transcripts, and protein sequence.

This software tool is designed to make requests to Ensembl's Variant Effect Predictor (VEP) Rest API from variant description/identifier entered by the user. The user is expected to know what type of variant description they have- Ensembl's variant identifier or Refseq variant description and the species. The genome build and select transcripts are only required if the user enters a variant description from Refseq. If entering variant identifier from Ensembl, the user will need to choose the allelic variant from a list that will be provided by the software.

Pre-requisites

variant_annotator will work on Linux operating systems.

Required software:

Python 3.12.0

License

Please see LICENSE

For installation instructions please see INSTALLATION

Operation Manuals

Please see MANUAL