Variation Annotation GENeraTor
A suite of perl modules that compares genomic variations with reference genome annotations and generates the possible effects each variant may have on the transcripts it overlaps. It evaluates each variation/transcript combination and describes the effects in the mRNA, CDS and protein sequence contexts. It provides details of the sequence and position of the change within the transcript/protein as well as Sequence Ontology terms to classify its consequences.
Master | Dev |
---|---|
Some of the code included in this package has dependencies on several packages:
- Samtools v1.3+
- vcftools
- Bio::DB::HTS
- bedtools2
- Not >=2.24.0, no upgrades until this ticket is resolved (which may involve code changes)
And various perl modules.
Please use setup.sh
to install the dependencies. Setting the environment variable CGP_PERLLIBS
allows you to to append to PERL5LIB
during install. Without this all dependancies are installed into the target area.
Please be aware that this expects basic C compilation libraries and tools to be available.
- Commit/push all relevant changes.
- Pull a clean version of the repo and use this for the following steps.
- Update
lib/Sanger/CGP/Vagrent.pm
to the correct version. - Update
CHANGES.md
to show major items. - Run
./setup.sh /path/to/local/inst
to create a local installation - Ensure your build enviroment contains Devel::Cover, Template and Pod::Coverage::CountParents. These can be loaded at the Sanger with
module load perl-testlibs
- Run
./prerelease.sh /path/to/local/inst
- Check all tests and coverage reports are acceptable.
- Commit the updated docs tree and updated module/version.
- Push commits.
- Use the GitHub tools to draft a release.
Copyright (c) 2014-2019 Genome Research Ltd.
Author: CASM/Cancer IT cgphelp@sanger.ac.uk
This file is part of VAGrENT.
VAGrENT is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.
- The usage of a range of years within a copyright statement contained within this distribution should be interpreted as being equivalent to a list of years including the first and last year specified and all consecutive years between them. For example, a copyright statement that reads ‘Copyright (c) 2005, 2007- 2009, 2011-2012’ should be interpreted as being identical to a statement that reads ‘Copyright (c) 2005, 2007, 2008, 2009, 2011, 2012’ and a copyright statement that reads ‘Copyright (c) 2005-2012’ should be interpreted as being identical to a statement that reads ‘Copyright (c) 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012’."