annotate variant_effect_predictor/Bio/EnsEMBL/Variation/TranscriptStructuralVariation.pm @ 1:d6778b5d8382 draft default tip

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