annotate variant_effect_predictor/Bio/EnsEMBL/DnaPepAlignFeature.pm @ 0:2bc9b66ada89 draft default tip

Uploaded
author mahtabm
date Thu, 11 Apr 2013 06:29:17 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
1 =head1 LICENSE
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
2
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
3 Copyright (c) 1999-2012 The European Bioinformatics Institute and
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
4 Genome Research Limited. All rights reserved.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
5
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
6 This software is distributed under a modified Apache license.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
7 For license details, please see
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
8
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
9 http://www.ensembl.org/info/about/code_licence.html
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
10
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
11 =head1 CONTACT
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
12
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
13 Please email comments or questions to the public Ensembl
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
14 developers list at <dev@ensembl.org>.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
15
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
16 Questions may also be sent to the Ensembl help desk at
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
17 <helpdesk@ensembl.org>.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
18
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
19 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
20
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
21 =head1 NAME
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
22
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
23 Bio::EnsEMBL::DnaPepAlignFeature - Ensembl specific dna-pep pairwise
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
24 alignment feature
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
25
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
26 =head1 SYNOPSIS
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
27
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
28 See BaseAlignFeature
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
29
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
30 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
31
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
32
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
33 package Bio::EnsEMBL::DnaPepAlignFeature;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
34
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
35 use strict;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
36
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
37 use Bio::EnsEMBL::BaseAlignFeature;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
38 use Scalar::Util qw(weaken isweak);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
39
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
40 use vars qw(@ISA);
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
41
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
42 @ISA = qw( Bio::EnsEMBL::BaseAlignFeature );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
43
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
44
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
45 =head2 new_fast
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
46
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
47 Arg [1] : hashref $hashref
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
48 A hashref which will be blessed into a PepDnaAlignFeature.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
49 Example : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
50 Description: This allows for very fast object creation when a large number
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
51 of DnaPepAlignFeatures needs to be created. This is a bit of
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
52 a hack but necessary when thousands of features need to be
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
53 generated within a couple of seconds for web display. It is
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
54 not recommended that this method be called unless you know what
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
55 you are doing. It requires knowledge of the internals of this
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
56 class and its superclasses.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
57 Returntype : Bio::EnsEMBL::DnaPepAlignFeature
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
58 Exceptions : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
59 Caller : Bio::EnsEMBL::DBSQL::ProteinAlignFeatureAdaptor
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
60 Status : Stable
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
61
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
62 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
63
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
64 sub new_fast {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
65 my ($class, $hashref) = @_;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
66 my $self = bless $hashref, $class;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
67 weaken($self->{adaptor}) if ( ! isweak($self->{adaptor}) );
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
68 return $self;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
69 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
70
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
71
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
72 =head2 _hit_unit
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
73
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
74 Arg [1] : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
75 Description: PRIVATE implementation of abstract superclass method. Returns
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
76 1 as the 'unit' used for the hit sequence.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
77 Returntype : int
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
78 Exceptions : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
79 Caller : Bio::EnsEMBL::BaseAlignFeature
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
80 Status : Stable
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
81
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
82
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
83 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
84
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
85 sub _hit_unit {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
86 return 1;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
87 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
88
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
89
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
90 =head2 _query_unit
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
91
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
92 Arg [1] : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
93 Description: PRIVATE implementation of abstract superclass method. Returns
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
94 3 as the 'unit' used for the query sequence.
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
95 Returntype : int
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
96 Exceptions : none
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
97 Caller : Bio::EnsEMBL::BaseAlignFeature
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
98 Status : Stable
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
99
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
100
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
101 =cut
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
102
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
103 sub _query_unit {
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
104 return 3;
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
105 }
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
106
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
107
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
108
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
109
2bc9b66ada89 Uploaded
mahtabm
parents:
diff changeset
110 1;