/
Collection.pm
429 lines (308 loc) · 9.89 KB
/
Collection.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
#
# bioperl module for Bio::Coordinate::Collection
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Heikki Lehvaslaiho <heikki-at-bioperl-dot-org>
#
# Copyright Heikki Lehvaslaiho
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::Coordinate::Collection - Noncontinuous match between two coordinate sets
=head1 SYNOPSIS
# create Bio::Coordinate::Pairs or other Bio::Coordinate::MapperIs somehow
$pair1; $pair2;
# add them into a Collection
$collection = Bio::Coordinate::Collection->new;
$collection->add_mapper($pair1);
$collection->add_mapper($pair2);
# create a position and map it
$pos = Bio::Location::Simple->new (-start => 5, -end => 9 );
$res = $collection->map($pos);
$res->match->start == 1;
$res->match->end == 5;
# if mapping is many to one (*>1) or many-to-many (*>*)
# you have to give seq_id not get unrelevant entries
$pos = Bio::Location::Simple->new
(-start => 5, -end => 9 -seq_id=>'clone1');
=head1 DESCRIPTION
Generic, context neutral mapper to provide coordinate transforms
between two B<disjoint> coordinate systems. It brings into Bioperl the
functionality from Ewan Birney's Bio::EnsEMBL::Mapper ported into
current bioperl.
This class is aimed for representing mapping between whole chromosomes
and contigs, or between contigs and clones, or between sequencing
reads and assembly. The submaps are automatically sorted, so they can
be added in any order.
To map coordinates to the other direction, you have to swap() the
collection. Keeping track of the direction and ID restrictions
are left to the calling code.
=head1 FEEDBACK
=head2 Mailing Lists
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to the
Bioperl mailing lists Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
=head2 Support
Please direct usage questions or support issues to the mailing list:
I<bioperl-l@bioperl.org>
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
=head2 Reporting Bugs
report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via the
web:
https://redmine.open-bio.org/projects/bioperl/
=head1 AUTHOR - Heikki Lehvaslaiho
Email: heikki-at-bioperl-dot-org
=head1 CONTRIBUTORS
Ewan Birney, birney@ebi.ac.uk
=head1 APPENDIX
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _
=cut
# Let the code begin...
package Bio::Coordinate::Collection;
use strict;
# Object preamble - inherits from Bio::Root::Root
use Bio::Coordinate::Result;
use Bio::Coordinate::Result::Gap;
use base qw(Bio::Root::Root Bio::Coordinate::MapperI);
sub new {
my($class,@args) = @_;
my $self = $class->SUPER::new(@args);
$self->{'_mappers'} = [];
my($in, $out, $strict, $mappers, $return_match) =
$self->_rearrange([qw(IN
OUT
STRICT
MAPPERS
RETURN_MATCH
)],
@args);
$in && $self->in($in);
$out && $self->out($out);
$mappers && $self->mappers($mappers);
$return_match && $self->return_match('return_match');
return $self; # success - we hope!
}
=head2 add_mapper
Title : add_mapper
Usage : $obj->add_mapper($mapper)
Function: Pushes one Bio::Coordinate::MapperI into the list of mappers.
Sets _is_sorted() to false.
Example :
Returns : 1 when succeeds, 0 for failure.
Args : mapper object
=cut
sub add_mapper {
my ($self,$value) = @_;
$self->throw("Is not a Bio::Coordinate::MapperI but a [$self]")
unless defined $value && $value->isa('Bio::Coordinate::MapperI');
# test pair range lengths
$self->warn("Coordinates in pair [". $value . ":" .
$value->in->seq_id . "/". $value->out->seq_id .
"] are not right.")
unless $value->test;
$self->_is_sorted(0);
push(@{$self->{'_mappers'}},$value);
}
=head2 mappers
Title : mappers
Usage : $obj->mappers();
Function: Returns or sets a list of mappers.
Example :
Returns : array of mappers
Args : array of mappers
=cut
sub mappers{
my ($self,@args) = @_;
if (@args) {
if (@args == 1 && ref $args[0] eq 'ARRAY') {
@args = @{$args[0]};
}
$self->throw("Is not a Bio::Coordinate::MapperI but a [$self]")
unless defined $args[0] && $args[0]->isa('Bio::Coordinate::MapperI');
push(@{$self->{'_mappers'}}, @args);
}
return @{$self->{'_mappers'}};
}
=head2 each_mapper
Title : each_mapper
Usage : $obj->each_mapper();
Function: Returns a list of mappers.
Example :
Returns : list of mappers
Args : none
=cut
sub each_mapper{
my ($self) = @_;
return @{$self->{'_mappers'}};
}
=head2 mapper_count
Title : mapper_count
Usage : my $count = $collection->mapper_count;
Function: Get the count of the number of mappers stored
in this collection
Example :
Returns : integer
Args : none
=cut
sub mapper_count{
my $self = shift;
return scalar @{$self->{'_mappers'} || []};
}
=head2 swap
Title : swap
Usage : $obj->swap;
Function: Swap the direction of mapping;input <-> output
Example :
Returns : 1
Args :
=cut
sub swap {
my ($self) = @_;
use Data::Dumper;
$self->sort unless $self->_is_sorted;
map {$_->swap;} @{$self->{'_mappers'}};
($self->{'_in_ids'}, $self->{'_out_ids'}) =
($self->{'_out_ids'}, $self->{'_in_ids'});
1;
}
=head2 test
Title : test
Usage : $obj->test;
Function: test that both components of all pairs are of the same length.
Ran automatically.
Example :
Returns : boolean
Args :
=cut
sub test {
my ($self) = @_;
my $res = 1;
foreach my $mapper ($self->each_mapper) {
unless( $mapper->test ) {
$self->warn("Coordinates in pair [". $mapper . ":" .
$mapper->in->seq_id . "/". $mapper->out->seq_id .
"] are not right.");
$res = 0;
}
}
$res;
}
=head2 map
Title : map
Usage : $newpos = $obj->map($pos);
Function: Map the location from the input coordinate system
to a new value in the output coordinate system.
Example :
Returns : new value in the output coordinate system
Args : integer
=cut
sub map {
my ($self,$value) = @_;
$self->throw("Need to pass me a value.")
unless defined $value;
$self->throw("I need a Bio::Location, not [$value]")
unless $value->isa('Bio::LocationI');
$self->throw("No coordinate mappers!")
unless $self->each_mapper;
$self->sort unless $self->_is_sorted;
if ($value->isa("Bio::Location::SplitLocationI")) {
my $result = Bio::Coordinate::Result->new();
foreach my $loc ( $value->sub_Location(1) ) {
my $res = $self->_map($loc);
map { $result->add_sub_Location($_) } $res->each_Location;
}
return $result;
} else {
return $self->_map($value);
}
}
=head2 _map
Title : _map
Usage : $newpos = $obj->_map($simpleloc);
Function: Internal method that does the actual mapping. Called multiple times
by map() if the location to be mapped is a split location
Example :
Returns : new location in the output coordinate system or undef
Args : Bio::Location::Simple
=cut
sub _map {
my ($self,$value) = @_;
my $result = Bio::Coordinate::Result->new(-is_remote=>1);
IDMATCH: {
# bail out now we if are forcing the use of an ID
# and it is not in this collection
last IDMATCH if defined $value->seq_id &&
! $self->{'_in_ids'}->{$value->seq_id};
foreach my $pair ($self->each_mapper) {
# if we are limiting input to a certain ID
next if defined $value->seq_id && $value->seq_id ne $pair->in->seq_id;
# if we haven't even reached the start, move on
next if $pair->in->end < $value->start;
# if we have over run, break
last if $pair->in->start > $value->end;
my $subres = $pair->map($value);
$result->add_result($subres);
}
}
$result->seq_id($result->match->seq_id) if $result->match;
unless ($result->each_Location) {
#build one gap;
my $gap = Bio::Location::Simple->new(-start => $value->start,
-end => $value->end,
-strand => $value->strand,
-location_type => $value->location_type
);
$gap->seq_id($value->seq_id) if defined $value->seq_id;
bless $gap, 'Bio::Coordinate::Result::Gap';
$result->seq_id($value->seq_id) if defined $value->seq_id;
$result->add_sub_Location($gap);
}
return $result;
}
=head2 sort
Title : sort
Usage : $obj->sort;
Function: Sort function so that all mappings are sorted by
input coordinate start
Example :
Returns : 1
Args :
=cut
sub sort{
my ($self) = @_;
@{$self->{'_mappers'}} = map { $_->[0] }
sort { $a->[1] <=> $b->[1] }
map { [ $_, $_->in->start] }
@{$self->{'_mappers'}};
#create hashes for sequence ids
$self->{'_in_ids'} = ();
$self->{'_out_ids'} = ();
foreach ($self->each_mapper) {
$self->{'_in_ids'}->{$_->in->seq_id} = 1;
$self->{'_out_ids'}->{$_->out->seq_id} = 1;
}
$self->_is_sorted(1);
}
=head2 _is_sorted
Title : _is_sorted
Usage : $newpos = $obj->_is_sorted;
Function: toggle for whether the (internal) coodinate mapper data are sorted
Example :
Returns : boolean
Args : boolean
=cut
sub _is_sorted{
my ($self,$value) = @_;
$self->{'_is_sorted'} = 1 if defined $value && $value;
return $self->{'_is_sorted'};
}
1;