annotate variant_effect_predictor/Bio/EnsEMBL/MappedSlice.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::MappedSlice - an object representing a mapped slice
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 # get a reference slice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
28 my $slice =
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
29 $slice_adaptor->fetch_by_region( 'chromosome', 14, 900000, 950000 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
30
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
31 # create MappedSliceContainer based on the reference slice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
32 my $msc = Bio::EnsEMBL::MappedSliceContainer->new( -SLICE => $slice );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
33
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
34 # set the adaptor for fetching AssemblySlices
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
35 my $asa = $slice->adaptor->db->get_AssemblySliceAdaptor;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
36 $msc->set_AssemblySliceAdaptor($asa);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
37
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
38 # add an AssemblySlice to your MappedSliceContainer
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
39 $msc->attach_AssemblySlice('NCBIM36');
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
40
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
41 foreach my $mapped_slice ( @{ $msc->get_all_MappedSlices } ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
42 print $mapped_slice->name, "\n";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
43
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
44 foreach my $sf ( @{ $mapped_slice->get_all_SimpleFeatures } ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
45 print " ", &to_string($sf), "\n";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
46 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
47 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
48
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
49 =head1 DESCRIPTION
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
50
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
51 NOTE: this code is under development and not fully functional nor tested
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
52 yet. Use only for development.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
53
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
54 This object represents a mapped slice, i.e. a slice that's attached
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
55 to a reference slice and a mapper to convert coordinates to/from the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
56 reference. The attachment is done via a MappedSliceContainer which
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
57 has the reference slice and the "container slice" defining the common
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
58 coordinate system for all MappedSlices.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
59
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
60 A MappedSlice is supposed to behave as close to a Bio::EnsEMBL::Slice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
61 as possible. Most Slice methods are implemented in MappedSlice and will
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
62 return an equivalent value to what Slice does. There are some exceptions
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
63 of unimplemented methods, either because there is no useful equivalent
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
64 for a MappedSlice to do, or they are too complicated.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
65
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
66 Not supported Bio::EnsEMBL::Slice methods:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
67
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
68 All deprecated methods
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
69 All Bio::PrimarySeqI compliance methods
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
70 expand
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
71 get_generic_features
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
72 get_seq_region_id
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
73 seq_region_Slice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
74
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
75 Not currently supported but maybe should/could:
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
76
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
77 calculate_pi
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
78 calculate_theta
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
79 get_base_count
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
80 get_by_Individual
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
81 get_by_strain
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
82 invert
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
83
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
84 Internally, a MappedSlice is a collection of Bio::EnsEMBL::Slices and
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
85 associated Bio::EnsEMBL::Mappers which map the slices to the common
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
86 container coordinate system.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
87
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
88 MappedSlices are usually created and attached to a MappedSliceContainer
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
89 by an adaptor/factory.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
90
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
91 =head1 METHODS
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
92
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
93 new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
94 add_Slice_Mapper_pair
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
95 get_all_Slice_Mapper_pairs
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
96 adaptor
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
97 container
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
98 name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
99 seq_region_name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
100 start
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
101 end
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
102 strand
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
103 length
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
104 seq_region_length
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
105 centrepoint
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
106 coord_system
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
107 coord_system_name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
108 is_toplevel
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
109 seq (not implemented yet)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
110 subseq (not implemented yet)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
111 get_repeatmasked_seq (not implemented yet)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
112 sub_MappedSlice (not implemented yet)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
113 project (not implemented yet)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
114
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
115 =head1 RELATED MODULES
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
116
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
117 Bio::EnsEMBL::MappedSlice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
118 Bio::EnsEMBL::DBSQL::AssemblySliceAdaptor
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
119 Bio::EnsEMBL::Compara::AlignSlice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
120 Bio::EnsEMBL::Compara::AlignSlice::Slice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
121 Bio::EnsEMBL::AlignStrainSlice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
122 Bio::EnsEMBL::StrainSlice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
123
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
124 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
125
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
126 package Bio::EnsEMBL::MappedSlice;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
127
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
128 use strict;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
129 use warnings;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
130 no warnings 'uninitialized';
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
131
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
132 use Bio::EnsEMBL::Utils::Argument qw(rearrange);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
133 use Bio::EnsEMBL::Utils::Exception qw(throw warning);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
134 use Bio::EnsEMBL::Mapper;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
135 use Scalar::Util qw(weaken);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
136
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
137 use vars qw($AUTOLOAD);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
138
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
139
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
140 =head2 new
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
141
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
142 Arg [ADAPTOR] : Adaptor $adaptor - an adaptor of the appropriate type
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
143 Arg [CONTAINER] : Bio::EnsEMBL::MappedSliceContainer $container - the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
144 container this MappedSlice is attached to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
145 Arg [NAME] : String $name - name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
146 Example : my $mapped_slice = Bio::EnsEMBL::MappedSlice->new(
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
147 -ADAPTOR => $adaptor,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
148 -CONTAINER => $container,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
149 -NAME => $name,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
150 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
151 Description : Constructor. Usually you won't call this method manually, but
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
152 the MappedSlice will be constructed by an adaptor/factory.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
153 Return type : Bio::EnsEMBL::MappedSlice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
154 Exceptions : thrown on wrong or missing arguments
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
155 Caller : general, MappedSlice adaptors
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
156 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
157 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
158
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
159 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
160
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
161 sub new {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
162 my $caller = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
163 my $class = ref($caller) || $caller;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
164
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
165 my ($adaptor, $container, $name) =
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
166 rearrange([qw(ADAPTOR CONTAINER NAME)], @_);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
167
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
168 # arguement check
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
169 unless ($container and ref($container) and
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
170 $container->isa('Bio::EnsEMBL::MappedSliceContainer')) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
171 throw("Need a MappedSliceContainer.");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
172 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
173
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
174 my $self = {};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
175 bless ($self, $class);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
176
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
177 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
178 # initialise object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
179 #
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
180
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
181 # need to weaken reference to prevent circular reference
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
182 weaken($self->{'container'} = $container);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
183
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
184 $self->adaptor($adaptor) if (defined($adaptor));
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
185 $self->{'name'} = $name if (defined($name));
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
186
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
187 $self->{'slice_mapper_pairs'} = [];
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
188
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
189 return $self;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
190 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
191
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
192
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
193 =head2 add_Slice_Mapper_pair
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
194
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
195 Arg[1] : Bio::EnsEMBL::Slice $slice - slice to add
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
196 Arg[2] : Bio::EnsEMBL::Mapper $mapper - the mapper for this slice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
197 Example : $mapped_slice->add_Slice_Mapper_pair($slice, $mapper);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
198 Description : Adds a native slice and a corresponding mapper to map to/from
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
199 the artificial container coord system.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
200 Return type : listref of Bio::EnsEMBL::MappedSlice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
201 Exceptions : thrown on wrong or missing arguments
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
202 Caller : general, MappedSlice adaptors
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
203 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
204 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
205
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
206 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
207
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
208 sub add_Slice_Mapper_pair {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
209 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
210 my $slice = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
211 my $mapper = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
212
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
213 # argument check
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
214 unless ($slice and ref($slice) and ($slice->isa('Bio::EnsEMBL::Slice') or $slice->isa('Bio::EnsEMBL::LRGSlice')) ) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
215 throw("You must provide a slice.");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
216 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
217
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
218 unless ($mapper and ref($mapper) and $mapper->isa('Bio::EnsEMBL::Mapper')) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
219 throw("You must provide a mapper.");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
220 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
221
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
222 push @{ $self->{'slice_mapper_pairs'} }, [ $slice, $mapper ];
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
223
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
224 return $self->{'slice_mapper_pairs'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
225 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
226
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
227
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
228 =head2 get_all_Slice_Mapper_pairs
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
229
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
230 Example : foreach my $pair (@{ $self->get_all_Slice_Mapper_pairs }) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
231 my ($slice, $mapper) = @$pair;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
232
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
233 # get container coordinates
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
234 my @coords = $mapper->map_coordinates(
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
235 $slice->seq_region_name,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
236 $slice->start,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
237 $slice->end,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
238 $slice->strand,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
239 'mapped_slice'
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
240 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
241
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
242 # ....
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
243 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
244 Description : Gets all Slice/Mapper pairs this MappedSlice is composed of.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
245 Each slice (and features on it) can be mapped onto the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
246 artificial container coord system using the mapper.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
247 Return type : listref of listref of a Bio::EnsEMBL::Slice and
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
248 Bio::EnsEMBL::Mapper pair
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
249 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
250 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
251 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
252 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
253
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
254 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
255
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
256 sub get_all_Slice_Mapper_pairs {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
257 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
258 return $self->{'slice_mapper_pairs'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
259 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
260
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
261
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
262 =head2 adaptor
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
263
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
264 Arg[1] : (optional) Adaptor $adaptor - the adaptor/factory for this
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
265 object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
266 Example : $mapped_slice->adaptor($assembly_slice_adaptor);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
267 Description : Getter/setter for the adaptor/factory for this object.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
268 Return type : Adaptor of appropriate type
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
269 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
270 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
271 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
272 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
273
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
274 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
275
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
276 sub adaptor {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
277 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
278 weaken($self->{'adaptor'} = shift) if (@_);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
279 return $self->{'adaptor'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
280 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
281
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
282
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
283 =head2 container
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
284
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
285 Arg[1] : (optional) Bio::EnsEMBL::MappedSliceContainer - the container
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
286 this object is attached to
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
287 Example : my $container = $mapped_slice->container;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
288 print $container->ref_slice->name, "\n";
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
289 Description : Getter/setter for the container this object is attached to. The
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
290 container will give you access to the reference slice, a common
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
291 artificial container slice, and a mapper to map to it from the
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
292 container coord system.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
293
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
294 The implementation uses a weak reference to attach the container
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
295 since the container holds a list of MappedSlices itself.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
296 Return type : Bio::EnsEMBL::MappedSliceContainer
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
297 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
298 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
299 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
300 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
301
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
302 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
303
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
304 sub container {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
305 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
306 weaken($self->{'container'} = shift) if (@_);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
307 return $self->{'container'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
308 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
309
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
310
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
311 =head2 name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
312
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
313 Arg[1] : String - the name of this object
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
314 Example : my $name = $mapped_slice->container->ref_slice->name .
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
315 ":mapped_" . $ident_string;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
316 $mapped_slice->name($name);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
317 Description : Getter/setter for this object's name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
318 Return type : String
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
319 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
320 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
321 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
322 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
323
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
324 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
325
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
326 sub name {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
327 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
328 $self->{'name'} = shift if (@_);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
329 return $self->{'name'};
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
330 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
331
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
332
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
333 =head2 seq_region_name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
334
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
335 Example : my $sr_name = $mapped_slice->seq_region_name;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
336 Description : Returns the seq_region name of the reference slice.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
337 Return type : String
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
338 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
339 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
340 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
341 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
342
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
343 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
344
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
345 sub seq_region_name {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
346 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
347 return $self->container->ref_slice->seq_region_name;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
348 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
349
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
350
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
351 =head2 start
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
352
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
353 Example : my $start = $mapped_slice->start;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
354 Description : Returns the start of the container slice.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
355 Return type : Int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
356 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
357 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
358 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
359 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
360
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
361 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
362
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
363 sub start {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
364 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
365 return $self->container->container_slice->start;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
366 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
367
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
368
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
369 =head2 end
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
370
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
371 Example : my $end = $mapped_slice->end;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
372 Description : Returns the end of the container slice.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
373 Return type : Int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
374 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
375 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
376 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
377 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
378
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
379 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
380
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
381 sub end {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
382 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
383 return $self->container->container_slice->end;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
384 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
385
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
386
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
387 =head2 strand
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
388
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
389 Example : my $strand = $mapped_slice->strand;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
390 Description : Returns the strand of the container slice.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
391 Return type : Int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
392 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
393 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
394 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
395 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
396
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
397 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
398
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
399 sub strand {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
400 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
401 return $self->container->container_slice->strand;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
402 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
403
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
404
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
405 =head2 length
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
406
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
407 Example : my $length = $mapped_slice->length;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
408 Description : Returns the length of the container slice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
409 Return type : Int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
410 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
411 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
412 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
413 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
414
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
415 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
416
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
417 sub length {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
418 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
419 return $self->container->container_slice->length;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
420 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
421
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
422
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
423 =head2 seq_region_length
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
424
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
425 Example : my $sr_length = $mapped_slice->seq_region_length;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
426 Description : Returns the seq_region length of the reference slice.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
427 Return type : Int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
428 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
429 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
430 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
431 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
432
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
433 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
434
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
435 sub seq_region_length {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
436 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
437 return $self->container->ref_slice->seq_region_length;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
438 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
439
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
440
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
441 =head2 centrepoint
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
442
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
443 Example : my $centrepoint = $mapped_slice->centrepoint;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
444 Description : Returns the centrepoint of the container slice.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
445 Return type : Int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
446 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
447 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
448 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
449 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
450
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
451 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
452
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
453 sub centrepoint {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
454 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
455 return $self->container->container_slice->centrepoint;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
456 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
457
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
458
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
459 =head2 coord_system
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
460
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
461 Example : my $cs = $mapped_slice->coord_system;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
462 Description : Returns the coord system of the container slice.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
463 Return type : Bio::EnsEMBL::CoordSystem
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
464 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
465 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
466 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
467 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
468
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
469 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
470
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
471 sub coord_system {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
472 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
473 return $self->container->container_slice->coord_system;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
474 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
475
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
476 =head2 coord_system_name
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
477
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
478 Example : my $cs_name = $mapped_slice->coord_system_name;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
479 Description : Returns the coord system name of the container slice.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
480 Return type : Int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
481 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
482 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
483 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
484 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
485
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
486 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
487
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
488 sub coord_system_name {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
489 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
490 return $self->container->container_slice->coord_system_name;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
491 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
492
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
493 =head2 is_toplevel
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
494
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
495 Example : my $toplevel_flag = $mapped_slice->is_toplevel;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
496 Description : Returns weather the container slice is toplevel.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
497 Return type : Int
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
498 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
499 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
500 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
501 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
502
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
503 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
504
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
505 sub is_toplevel {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
506 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
507 return $self->container->container_slice->is_toplevel;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
508 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
509
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
510
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
511 =head2 seq
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
512
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
513 Example : my $seq = $mapped_slice->seq()
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
514 Description : Retrieves the expanded sequence of this mapped slice,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
515 including "-" characters where there are inserts in any other
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
516 mapped slices. This will align with the sequence returned by
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
517 the container's seq() method.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
518 Return type : String
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
519 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
520 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
521 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
522 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
523
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
524 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
525
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
526 sub seq {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
527 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
528
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
529 # create an empty string
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
530 my $ms_seq = '';
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
531
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
532 # this coord represents the current position in the MS sequence
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
533 my $start = 0;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
534
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
535 # get slice/mapper pairs from mapped slice (usually only one anyway)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
536 foreach my $pair(@{$self->get_all_Slice_Mapper_pairs()}) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
537 my ($s, $m) = @$pair;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
538
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
539 # make sure to send extra args
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
540 # eg strain slices might need read coverage filtering
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
541 my $seq = $s->seq(@_);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
542
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
543 # project from mapped slice to reference slice using the mapper
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
544 foreach my $ref_coord($m->map_coordinates('mapped_slice', 1, CORE::length($seq), $s->strand, 'mapped_slice')) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
545
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
546 # normal coord
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
547 if(!$ref_coord->isa('Bio::EnsEMBL::Mapper::IndelCoordinate') && !$ref_coord->isa('Bio::EnsEMBL::Mapper::Gap')) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
548
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
549 # project from reference slice to container slice using the container's mapper
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
550 foreach my $ms_coord($self->container->mapper->map_coordinates($self->container->ref_slice->seq_region_name, $ref_coord->start, $ref_coord->end, $ref_coord->strand, 'ref_slice')) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
551
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
552 # normal coord
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
553 if(!$ms_coord->isa('Bio::EnsEMBL::Mapper::IndelCoordinate') && !$ms_coord->isa('Bio::EnsEMBL::Mapper::Gap')) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
554 $ms_seq .= substr($seq, $start, $ms_coord->length);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
555
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
556 $start += $ms_coord->length();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
557 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
558
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
559 # indel coord
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
560 else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
561 $ms_seq .= '-' x $ms_coord->length();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
562 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
563 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
564 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
565
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
566 # indel / gap
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
567 else {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
568
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
569 # if there's a gap here aswell, add corresponding sequence
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
570 if($ref_coord->gap_length > 0) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
571 $ms_seq .= substr($seq, $start, $ref_coord->gap_length);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
572 $start += $ref_coord->gap_length;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
573 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
574
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
575 # add "-" to the sequence
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
576 $ms_seq .= '-' x ($ref_coord->length() - $ref_coord->gap_length());
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
577 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
578 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
579 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
580
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
581 return $ms_seq;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
582 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
583
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
584 sub subseq {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
585 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
586
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
587 sub get_repeatmasked_seq {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
588 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
589
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
590 sub sub_MappedSlice {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
591 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
592
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
593 sub project {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
594 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
595
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
596
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
597 =head2 AUTOLOAD
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
598
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
599 Arg[1..N] : Arguments passed on to the calls on the underlying slices.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
600 Example : my @simple_features = @{ $mapped_slice->get_all_SimpleFeatures };
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
601 Description : Aggregate data gathered from composing Slices.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
602 This will call Slice->get_all_* and combine the results.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
603 Coordinates will be transformed to be on the container slice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
604 coordinate system.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
605
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
606 Calls involving DAS features are skipped since the DAS adaptor
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
607 handles coordinate conversions natively.
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
608 Return type : listref of features (same type as corresponding Slice method)
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
609 Exceptions : none
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
610 Caller : general
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
611 Status : At Risk
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
612 : under development
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
613
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
614 =cut
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
615
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
616 sub AUTOLOAD {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
617 my $self = shift;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
618
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
619 my $method = $AUTOLOAD;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
620 $method =~ s/.*:://;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
621
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
622 # AUTOLOAD should only deal with get_all_* methods
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
623 return unless ($method =~ /^get_all_/);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
624
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
625 # skip DAS methods
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
626 return if ($method =~ /DAS/);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
627
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
628 my @mapped_features = ();
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
629
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
630 foreach my $pair (@{ $self->get_all_Slice_Mapper_pairs }) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
631 my ($slice, $mapper) = @$pair;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
632 #warn $slice->name;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
633
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
634 # call $method on each native slice composing the MappedSlice
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
635 my @features = @{ $slice->$method(@_) };
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
636
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
637 # map features onto the artificial container coordinate system
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
638 foreach my $f (@features) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
639
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
640 my @coords = $mapper->map_coordinates(
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
641 $f->slice->seq_region_name,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
642 $f->start,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
643 $f->end,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
644 $f->strand,
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
645 'mapped_slice'
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
646 );
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
647
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
648 # sanity check
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
649 if (scalar(@coords) > 1) {
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
650 warning("Got more than one Coordinate returned, expected only one!\n");
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
651 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
652
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
653 $f->start($coords[0]->start);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
654 $f->end($coords[0]->end);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
655 $f->strand($coords[0]->strand);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
656 $f->slice($self->container->container_slice);
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
657
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
658 push @mapped_features, $f;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
659 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
660
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
661 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
662
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
663 return \@mapped_features;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
664 }
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
665
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
666
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
667 1;
21066c0abaf5 Uploaded
willmclaren
parents:
diff changeset
668