annotate variant_effect_predictor/Bio/EnsEMBL/Mapper/Pair.pm @ 2:a5976b2dce6f

changing defualt values for ensembl database
author mahtabm
date Thu, 11 Apr 2013 17:15:42 +1000
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::Mapper::Pair
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 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 Two regions mapped between different coordinate systems are each
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30 represented by a Bio::EnsEMBL::Mapper::Unit and joined together as a
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 Bio::EnsEMBL::Mapper::Pair.
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 package Bio::EnsEMBL::Mapper::Pair;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39 use strict;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41 sub new {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42 my ( $proto, $from, $to, $ori ) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44 my $class = ref($proto) || $proto;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46 return
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 bless( { 'from' => $from, 'to' => $to, 'ori' => $ori }, $class );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50 =head2 to
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52 Arg 1 Bio::EnsEMBL::Mapper::Unit $seqobj
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 from and to represent the two regions
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 which are mapped to each other
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 Function accessor method
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 Returntype Bio::EnsEMBL::Mapper::Unit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57 Exceptions none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58 Caller Bio::EnsEMBL::Mapper::Pair
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63 sub to {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 my ( $self, $value ) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 if ( defined($value) ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 $self->{'to'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70 return $self->{'to'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73 =head2 from
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 Arg 1 Bio::EnsEMBL::Mapper::Unit $seqobj
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 from and to represent the two regions
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 which are mapped to each other
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78 Function accessor method
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79 Returntype Bio::EnsEMBL::Mapper::Unit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80 Exceptions none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 Caller Bio::EnsEMBL::Mapper::Pair
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 sub from {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 my ( $self, $value ) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 if ( defined($value) ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 $self->{'from'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92 return $self->{'from'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 =head2 ori
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97 Arg 1 Bio::EnsEMBL::Mapper::Unit $ori
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98 Function accessor method
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99 relative orientation of the the
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100 two mapped regions
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 Returntype Bio::EnsEMBL::Mapper::Unit
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102 Exceptions none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 Caller Bio::EnsEMBL::Mapper::Pair
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 sub ori {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 my ( $self, $value ) = @_;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 if ( defined($value) ) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112 $self->{'ori'} = $value;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 return $self->{'ori'};
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118 1;