annotate variant_effect_predictor/Bio/EnsEMBL/Mapper/Unit.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::Unit - One side of a map 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
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 package Bio::EnsEMBL::Mapper::Unit;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43 my ( $proto, $id, $start, $end ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 my $class = ref($proto) || $proto;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 return
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48 bless( { 'id' => $id, 'start' => $start, 'end' => $end }, $class );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 =head2 id
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53 Arg 1 int|char $id
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 the id of the object (e.g. seq_region_name) which is mapped
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 Function accessor method
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 Returntype int|char
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 Exceptions none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 Caller Bio::EnsEMBL::Mapper::Unit
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 id {
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->{'id'} = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70 return $self->{'id'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 =head2 start
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 Arg 1 int $start
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76 the start coordinate of the mapped
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77 region which this object represents
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 Function accessor method
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79 Returntype int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 Exceptions none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 Caller Bio::EnsEMBL::Mapper::Unit
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
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 sub start {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 if ( defined($value) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90 $self->{'start'} = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 return $self->{'start'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 =head2 end
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 Arg 1 int $end
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 the end coordinate of the mapped
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100 region which this object represents
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101 Function accessor method
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102 Returntype int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 Exceptions none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 Caller Bio::EnsEMBL::Mapper::Unit
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 Status Stable
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 sub end {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 my ( $self, $value ) = @_;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 if ( defined($value) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113 $self->{'end'} = $value;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116 return $self->{'end'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 1;