annotate variant_effect_predictor/Bio/EnsEMBL/Map/QtlFeature.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::Map::QtlFeature
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 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29 Represents a QtlFeature in the EnsEMBL database. QtlFeatures are
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30 generally very long and its not clear wether a representation in Contig
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31 coordinates actually makes sense. In the database they will have
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 chromosomal coordinates.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34 =head1 METHODS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 package Bio::EnsEMBL::Map::QtlFeature;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 use vars qw(@ISA);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 use Bio::EnsEMBL::Feature;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 @ISA = qw(Bio::EnsEMBL::Feature);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48 =head2 new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50 Arg [1] : Bio::EnsEMBL::Map::DBSQL::QtlFeatureAdaptor $adaptor
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 Example : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 Description: Create a QtlFeature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 Returntype : Bio::EnsEMBL::Map::QtlFeature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 Caller : general, DBSQL::QtlFeatureAdaptor
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 Status : Stable
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61 my ( $class, $adaptor, $slice, $start, $end, $qtl, $analysis ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 $class = ref( $class ) ||$class;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 my $self = bless( {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65 'slice' => $slice,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 'start' => $start,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67 'end' => $end,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68 'qtl' => $qtl,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 'analysis' => $analysis,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70 'strand' => 0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 }, $class );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 $self->adaptor($adaptor);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74 return $self;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 =head2 qtl
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 Arg [1] : Bio::EnsEMBL::Map::Qtl $qtl
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 the qtl object for this feature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 Example : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83 Description: return the Qtl object associated with this location
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 Returntype : Bio::EnsEMBL::Map::Qtl
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87 Status : Stable
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 sub qtl {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 if(@_) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95 $self->{'qtl'} = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 return $self->{'qtl'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 =head2 strand
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 Arg [1] : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 Example : $strand = $qtl_feat->strand();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 Description: Overrides the Feature strand method to always return a
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 value of 0 for qtl features (they are unstranded features)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 Returntype : int (always 0)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 Status : Stable
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116 sub strand {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 return 0;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123 =head2 move
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125 Arg [1] : $start - The new end of this qtl feature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126 Arg [2] : $end - The new start of this qtl feature
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127 Arg [3] : $strand - ignored always set to 0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128 Example : $qtl_feat->move(1, 10_000);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 Description: Overrides superclass move() method to ensure strand is always 0.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130 See Bio::EnsEMBL::Feature::move
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131 Returntype : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134 Status : Stable
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138 sub move {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139 my ($self, $start, $end, $strand) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141 #maintain a strandedness of 0
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142 return $self->SUPER::move($start,$end,0);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
146
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
147 1;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
148
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
149