annotate variant_effect_predictor/Bio/EnsEMBL/ProjectionSegment.pm @ 3:d30fa12e4cc5 default tip

Merge heads 2:a5976b2dce6f and 1:09613ce8151e which were created as a result of a recently fixed bug.
author devteam <devteam@galaxyproject.org>
date Mon, 13 Jan 2014 10:38:30 -0500
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::ProjectionSegment - part of the list that is returned from
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
24 project function calls
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
25
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
26 =head1 SYNOPSIS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
27
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
28 $slice =
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
29 $sa->fetch_by_region( 'chromosome', 'X', 1_000_000, 2_000_000 );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
30
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
31 my $projection = $slice->project("clone");
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
32
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
33 foreach my $projection_segment (@$projection) {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
34 print( " from_start ", $projection_segment->from_start(), "\n" );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
35 print( " from_end ", $projection_segment->from_end(), "\n" );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
36 print( " to_Slice ",
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
37 $projection_segment->to_Slice()->name(), "\n" );
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
38 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
39
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
40 =head1 DESCRIPTION
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
41
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
42 The ProjectionSegment is a helper object to make the arrays returned by
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
43 project more accessible. Instead of writing $segment->[0], $segment->[1]
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
44 or $segment->[2] its possible to use the more descriptive notation of
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
45 $segment->from_start(), $segement->from_end(), $segment->to_Slice().
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
46
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
47 =head1 METHODS
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
48
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
49 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
50
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
51 package Bio::EnsEMBL::ProjectionSegment;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
52
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
53 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
54 # WARNING: THIS CLASS IS REPRESENTED BY A BLESSED ARRAY REFERENCE
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
55 # NOT A HASH REFERENCE
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
56 #
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
57
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
58
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
59
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
60
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
61
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
62 =head2 from_start
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
63
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
64 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
65 Example : $coord_in_fetaure_start = $segment->from_start()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
66 Description: First element in projects returned segment lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
67 Returntype : int
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
68 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
69 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
70 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
71
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
72 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
73
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
74 sub from_start {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
75 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
76 return $self->[0];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
77 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
78
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
79
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
80
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
81 =head2 from_end
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
82
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
83 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
84 Example : $coord_in_feature_end = $segment->from_end()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
85 Description: Second element in projects returned segment lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
86 Returntype : int
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
87 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
88 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
89 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
90
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
91 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
92
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
93 sub from_end {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
94 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
95 return $self->[1];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
96 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
97
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
98
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
99
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
100
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
101 =head2 to_Slice
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
102
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
103 Args : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
104 Example : $target_slice = $segment->to_Slice()
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
105 Description: Third element in projects returned segment lists
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
106 Returntype : Bio::EnsEMBL::Slice
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
107 Exceptions : none
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
108 Caller : general
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
109 Status : Stable
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
110
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
111 =cut
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
112
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
113 sub to_Slice {
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
114 my $self = shift;
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
115 return $self->[2];
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
116 }
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
117
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
118
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
119
1f6dce3d34e0 Uploaded
mahtabm
parents:
diff changeset
120 1;