annotate variant_effect_predictor/Bio/EnsEMBL/Variation/TranscriptStructuralVariation.pm @ 3:d30fa12e4cc5 default tip

Merge heads 2:a5976b2dce6f and 1:09613ce8151e which were created as a result of a recently fixed bug.
author devteam <devteam@galaxyproject.org>
date Mon, 13 Jan 2014 10:38:30 -0500
parents 1f6dce3d34e0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
1 =head1 LICENSE
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
2
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
5
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
6 This software is distributed under a modified Apache license.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
7 For license details, please see
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
8
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
10
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
11 =head1 CONTACT
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
12
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
15
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
17 <helpdesk@ensembl.org>.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
18
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
19 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
20
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
21 =head1 NAME
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
22
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
23 Bio::EnsEMBL::Variation::TranscriptStructuralVariation
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27 use Bio::EnsEMBL::Variation::TranscriptStructuralVariation;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 my $tv = Bio::EnsEMBL::Variation::TranscriptVariation->new(
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 -transcript => $transcript,
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 -structural_variation_feature => $svf
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32 );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36 A TranscriptStructuralVariation object represents a structural variation feature
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 which is in close proximity to an Ensembl transcript. A
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38 TranscriptStructuralVariation object has several attributes which define the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 relationship of the variation to the transcript.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 package Bio::EnsEMBL::Variation::TranscriptStructuralVariation;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 use warnings;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48 use Bio::EnsEMBL::Variation::TranscriptStructuralVariationAllele;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50 use base qw(Bio::EnsEMBL::Variation::StructuralVariationOverlap Bio::EnsEMBL::Variation::BaseTranscriptVariation);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52 sub new {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 my $class = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 my %args = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 # swap a '-transcript' argument for a '-feature' one for the superclass
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60 for my $arg (keys %args) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61 if (lc($arg) eq '-transcript') {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 $args{'-feature'} = delete $args{$arg};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 # call the superclass constructor
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 my $self = $class->SUPER::new(%args) || return undef;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 # rebless the alleles from vfoas to tvas
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70 map { bless $_, 'Bio::EnsEMBL::Variation::TranscriptStructuralVariationAllele' }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 @{ $self->get_all_TranscriptStructuralVariationAlleles };
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 return $self;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 =head2 add_TranscriptStructuralVariationAllele
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 Arg [1] : A Bio::EnsEMBL::Variation::TranscriptStructuralVariationAllele instance
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 Description: Add an allele to this TranscriptStructuralVariation
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 Returntype : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 Exceptions : throws if the argument is not the expected type
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 sub add_TranscriptStructuralVariationAllele {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 my ($self, $svoa) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 assert_ref($svoa, 'Bio::EnsEMBL::Variation::TranscriptStructuralVariationAllele');
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 return $self->SUPER::add_BaseVariationFeatureOverlapAllele($svoa);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 =head2 get_reference_TranscriptStructuralVariationAllele
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 Description: Get the object representing the reference allele of this TranscriptStructuralVariation
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 Returntype : Bio::EnsEMBL::Variation::TranscriptStructuralVariationAllele instance
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 sub get_reference_TranscriptStructuralVariationAllele {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 return $self->SUPER::get_reference_BaseVariationFeatureOverlapAllele(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 =head2 get_all_alternate_TranscriptStructuralVariationAlleles
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 Description: Get a list of the alternate alleles of this TranscriptStructuralVariation
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 Returntype : listref of Bio::EnsEMBL::Variation::TranscriptStructuralVariationAllele objects
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 sub get_all_alternate_TranscriptStructuralVariationAlleles {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117 return $self->SUPER::get_all_alternate_BaseVariationFeatureOverlapAlleles(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 =head2 get_all_TranscriptStructuralVariationAlleles
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
121
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
122 Description: Get a list of the all the alleles, both reference and alternate, of
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
123 this TranscriptStructuralVariation
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
124 Returntype : listref of Bio::EnsEMBL::Variation::TranscriptStructuralVariationAllele objects
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
125 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
126 Status : At Risk
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
127
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
128 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
129
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
130 sub get_all_TranscriptStructuralVariationAlleles {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
131 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
132 return $self->SUPER::get_all_BaseVariationFeatureOverlapAlleles(@_);
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
133 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
134
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
135 1;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
136