annotate variant_effect_predictor/Bio/EnsEMBL/Variation/BaseTranscriptVariationAllele.pm @ 0:21066c0abaf5 draft

Uploaded
author willmclaren
date Fri, 03 Aug 2012 10:04:48 -0400
parents
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::BaseTranscriptVariationAllele
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::BaseTranscriptVariationAllele;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31 An helper class for representing an overlap of a Transcript and a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 Variation allele (either sequence or structural). Should not be invoked
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33 directly.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37 package Bio::EnsEMBL::Variation::BaseTranscriptVariationAllele;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 use warnings;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42 use base qw(Bio::EnsEMBL::Variation::VariationFeatureOverlapAllele);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44 =head2 base_transcript_variation
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46 Description: Get/set the associated BaseTranscriptVariation
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 Returntype : Bio::EnsEMBL::Variation::BaseTranscriptVariation
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48 Exceptions : throws if the argument is the wrong type
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 sub base_transcript_variation {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 my ($self, $btv) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 assert_ref($btv, 'Bio::EnsEMBL::Variation::BaseTranscriptVariation') if $btv;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 return $self->variation_feature_overlap($btv);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59 =head2 transcript
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61 Description: Get the associated Transcript
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 Returntype : Bio::EnsEMBL::Transcript
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68 sub transcript {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70 return $self->base_transcript_variation->transcript;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 =head2 base_variation_feature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 Description: Get the associated BaseVariationFeature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 Returntype : Bio::EnsEMBL::Variation::BaseVariationFeature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 sub base_variation_feature {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 return $self->base_transcript_variation->base_variation_feature;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87 1;