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