annotate dir_plugins/TSSDistance.pm @ 0:e545d0a25ffe draft

Uploaded
author dvanzessen
date Mon, 15 Jul 2019 05:17:17 -0400
parents
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 TSSDistance
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 TSSDistance.pm ~/.vep/Plugins
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
31 ./vep -i variations.vcf --plugin CCDSFilter
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 A VEP plugin that calculates the distance from the transcription
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
36 start site for upstream variants.
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
37
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
38 =cut
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
39
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
40 package TSSDistance;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
41
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
42 use Bio::EnsEMBL::Variation::Utils::BaseVepPlugin;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
43
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
44 use base qw(Bio::EnsEMBL::Variation::Utils::BaseVepPlugin);
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
45
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
46 sub get_header_info {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
47 return {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
48 TSSDistance => "Distance from the transcription start site"
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
49 };
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
50 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
51
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
52 sub feature_types {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
53 return ['Transcript'];
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
54 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
55
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
56 sub variant_feature_types {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
57 return ['BaseVariationFeature'];
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
58 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
59
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
60 sub run {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
61 my ($self, $tva) = @_;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
62
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
63 my $t = $tva->transcript;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
64 my $vf = $tva->base_variation_feature;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
65
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
66 my $dist;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
67
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
68 if ($t->strand == 1) {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
69 $dist = $t->start - $vf->end;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
70 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
71 else {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
72 $dist = $vf->start - $t->end;
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
73 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
74
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
75 if ($dist > 0) {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
76 return {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
77 TSSDistance => $dist,
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
78 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
79 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
80 else {
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
81 return {};
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
82 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
83 }
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
84
e545d0a25ffe Uploaded
dvanzessen
parents:
diff changeset
85 1;