annotate dir_plugins/ProteinSeqs.pm @ 3:49397129aec0 draft

Uploaded
author dvanzessen
date Mon, 15 Jul 2019 05:20:39 -0400
parents e545d0a25ffe
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
1 =head1 LICENSE
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
2
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
3 Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
4 Copyright [2016-2018] EMBL-European Bioinformatics Institute
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
5
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
6 Licensed under the Apache License, Version 2.0 (the "License");
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
7 you may not use this file except in compliance with the License.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
8 You may obtain a copy of the License at
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
9
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
10 http://www.apache.org/licenses/LICENSE-2.0
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
11
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
12 Unless required by applicable law or agreed to in writing, software
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
13 distributed under the License is distributed on an "AS IS" BASIS,
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
15 See the License for the specific language governing permissions and
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
16 limitations under the License.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
17
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
18 =head1 CONTACT
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
19
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
20 Ensembl <http://www.ensembl.org/info/about/contact/index.html>
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
21
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
22 =cut
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
23
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
24 =head1 NAME
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
25
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
26 ProteinSeqs
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
27
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
28 =head1 SYNOPSIS
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
29
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
30 mv ProteinSeqs.pm ~/.vep/Plugins
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
31 ./vep -i variations.vcf --plugin ProteinSeqs,reference.fa,mutated.fa
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
32
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
33 =head1 DESCRIPTION
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
34
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
35 This is a plugin for the Ensembl Variant Effect Predictor (VEP) that
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
36 prints out the reference and mutated protein sequences of any
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
37 proteins found with non-synonymous mutations in the input file.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
38
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
39 You should supply the name of file where you want to store the
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
40 reference protein sequences as the first argument, and a file to
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
41 store the mutated sequences as the second argument.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
42
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
43 Note that, for simplicity, where stop codons are gained the plugin
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
44 simply substitutes a '*' into the sequence and does not truncate the
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
45 protein. Where a stop codon is lost any new amino acids encoded by the
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
46 mutation are appended to the sequence, but the plugin does not attempt
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
47 to translate until the next downstream stop codon. Also, the protein
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
48 sequence resulting from each mutation is printed separately, no attempt
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
49 is made to apply multiple mutations to the same protein.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
50
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
51 =cut
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
52
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
53 package ProteinSeqs;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
54
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
55 use strict;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
56 use warnings;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
57
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
58 use base qw(Bio::EnsEMBL::Variation::Utils::BaseVepPlugin);
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
59
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
60 sub version {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
61 return '2.4';
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
62 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
63
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
64 sub feature_types {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
65 return ['Transcript'];
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
66 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
67
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
68 sub new {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
69 my $class = shift;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
70
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
71 my $self = $class->SUPER::new(@_);
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
72
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
73 if($self->{config}->{fork}) {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
74 print STDERR "WARNING: Plugin ProteinSeqs is disabling forking\n" unless $self->{config}->{quiet};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
75 delete($self->{config}->{fork});
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
76 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
77
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
78 # use some default file names if none are supplied
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
79
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
80 my $ref_file = $self->params->[0] || 'reference.fa';
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
81 my $mut_file = $self->params->[1] || 'mutated.fa';
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
82
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
83 open $self->{ref_file}, ">$ref_file" or die "Failed to open $ref_file";
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
84 open $self->{mut_file}, ">$mut_file" or die "Failed to open $mut_file";
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
85
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
86 return $self;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
87 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
88
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
89 sub run {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
90 my ($self, $tva) = @_;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
91
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
92 # check if we have a mutant amino acid, if not there isn't much we can do!
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
93
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
94 if (my $mut_aa = $tva->peptide) {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
95
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
96 # get the peptide coordinates
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
97
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
98 my $tl_start = $tva->transcript_variation->translation_start;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
99 my $tl_end = $tva->transcript_variation->translation_end;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
100
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
101 # and our reference sequence
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
102
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
103 my $ref_seq = $tva->transcript_variation->_peptide;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
104
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
105 # splice the mutant peptide sequence into the reference sequence
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
106
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
107 my $mut_seq = $ref_seq;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
108
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
109 substr($mut_seq, $tl_start-1, $tl_end - $tl_start + 1) = $mut_aa;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
110
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
111 # print out our reference and mutant sequences
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
112
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
113 my $translation_id = $tva->transcript->translation->stable_id;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
114
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
115 # only print the reference sequence if we haven't printed it yet
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
116
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
117 $self->print_fasta($ref_seq, $translation_id, $self->{ref_file})
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
118 unless $self->{printed_ref}->{$translation_id}++;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
119
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
120 # we always print the mutated sequence as each mutation may have
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
121 # a different consequence
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
122
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
123 $self->print_fasta($mut_seq, $tva->hgvs_protein, $self->{mut_file});
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
124 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
125
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
126 # return an empty hashref because we don't want to add
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
127 # anything to the VEP output file
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
128
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
129 return {};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
130 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
131
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
132 sub print_fasta {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
133 my ($self, $peptide, $id, $fh) = @_;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
134
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
135 # break the sequence into 80 characters per line
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
136
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
137 $peptide =~ s/(.{80})/$1\n/g;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
138
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
139 # get rid of any trailing newline
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
140
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
141 chomp $peptide;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
142
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
143 # print the sequence
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
144
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
145 print $fh ">$id\n$peptide\n";
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
146 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
147
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
148 sub STORABLE_freeze {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
149 my ($self, $cloning) = @_;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
150 return if $cloning;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
151
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
152 close $self->{ref_file};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
153 close $self->{mut_file};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
154
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
155 delete $self->{ref_file};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
156 delete $self->{ref_file};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
157 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
158
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
159 sub STORABLE_thaw {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
160 my ($self, $cloning) = @_;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
161 return if $cloning;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
162
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
163 my $ref_file = $self->params->[0] || 'reference.fa';
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
164 my $mut_file = $self->params->[1] || 'mutated.fa';
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
165
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
166 open $self->{ref_file}, ">>$ref_file" or die "Failed to open $ref_file";
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
167 open $self->{mut_file}, ">>$mut_file" or die "Failed to open $mut_file";
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
168 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
169
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
170 1;