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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
# $Id: SequenceFamily.pm 16168 2009-09-25 21:07:32Z cjfields $
#
# BioPerl module for Bio::Cluster::SequenceFamily
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Shawn Hoon <shawnh@fugu-sg.org>
#
# Copyright Shawn Hoon
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::Cluster::SequenceFamily - Sequence Family object
=head1 SYNOPSIS
use Bio::SeqIO;
use Bio::Cluster::SequenceFamily;
use File::Spec;
my $file = File::Spec->catfile('t','data','swiss.dat');
my $seqio= Bio::SeqIO->new(-format => 'swiss',
-file => $file);
my @mem;
while(my $seq = $seqio->next_seq){
push @mem, $seq;
}
#create the family
my $family = Bio::Cluster::SequenceFamily->new(
-family_id=>"Family_1",
-description=>"Family Description Here",
-annotation_score=>"100",
-members=>\@mem);
#access the family
foreach my $mem ($family->get_members){
print $mem->display_id."\t".$mem->desc."\n";
}
#select members if members have a Bio::Species Object
my @mem = $family->get_members(-binomial=>"Homo sapiens");
@mem = $family->get_members(-ncbi_taxid => 9606);
@mem = $family->get_members(-common_name=>"Human");
@mem = $family->get_members(-species=>"sapiens");
@mem = $family->get_members(-genus=>"Homo");
=head1 DESCRIPTION
This is a simple Family object that may hold any group of object. For more
specific families, one should derive from FamilyI.
=head1 FEEDBACK
Email bioperl-l@bioperl.org for support and 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 one
of 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:
http://bugzilla.open-bio.org/
=head1 AUTHOR - Shawn Hoon
Email shawnh@fugu-sg.org
=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::Cluster::SequenceFamily;
use strict;
use base qw(Bio::Root::Root Bio::Cluster::FamilyI);
=head2 new
Title : new
Usage : my $family = Bio::Cluster::SequenceFamily->new(
-family_id=>"Family_1",
-description=>"Family Description Here",
-annotation_score=>"100",
-members=>\@mem);
Function: Constructor for SequenceFamily object
Returns : Bio::Cluster::SequenceFamily object
See L<Bio::Cluster::SequenceFamily>.
=cut
sub new {
my ($class,@args) = @_;
my $self = $class->SUPER::new(@args);
my ($id,$description,$version,$annot_score,
$family_score,$members) = $self->_rearrange([qw(FAMILY_ID DESCRIPTION VERSION
ANNOTATION_SCORE
FAMILY_SCORE MEMBERS)],@args);
$self->{'_members'} = [];
$id && $self->family_id($id);
$description && $self->description($description);
$version && $self->version($version);
$annot_score && $self->annotation_score($annot_score);
$family_score && $self->family_score($family_score);
$members && $self->add_members($members);
return $self;
}
=head2 version
Title : version
Usage : $family->version("1.0");
Function: get/set for version
Returns : a string version of the family generated.
=cut
sub version{
my ($self,$value) = @_;
if($value){
$self->{'_version'} =$value;
}
return $self->{'_version'};
}
=head2 annotation_score
Title : annotation_score
Usage : $family->annotation_score(100);
Function: get/set for annotation_score which
represent the confidence in which the
consensus description has been assigned
to the family.
Returns : Bio::SimpleAlign
See L<Bio::SimpleAlign>
=cut
sub annotation_score{
my ($self,$score) = @_;
if($score){
$self->{'_annotation_score'} = $score;
}
return $self->{'_annotation_score'};
}
=head2 alignment
Title : alignment
Usage : $family->alignment($align);
Function: get/set for an alignment object representing
the multiple alignment of the members of the family.
Returns : Bio::SimpleAlign
See L<Bio::SimpleAlign>
=cut
sub alignment {
my ($self,$align) = @_;
if($align){
$self->{'_alignment'} = $align;
}
return $self->{'_alignment'};
}
=head2 tree
Title : tree
Usage : $family->tree($tree);
Function: get/set for an tree object representing
the phylogenetic tree of the family.
Returns : Bio::Tree
See L<Bio::Tree>
=cut
sub tree {
my ($self,$tree) = @_;
if($tree) {
$self->{'_tree'} = $tree;
}
return $self->{'_tree'};
}
=head1 L<Bio::Cluster::FamilyI> methods
=cut
=head2 family_score
Title : family_score
Usage : Bio::Cluster::FamilyI->family_score(95);
Function: get/set for the score of algorithm used to generate
the family if present
This is aliased to cluster_score().
Returns : the score
Args : the score
=cut
sub family_score {
return shift->cluster_score(@_);
}
=head2 family_id
Title : family_id
Usage : $family->family_id("Family_1");
Function: get/set for family id
This is aliased to display_id().
Returns : a string specifying identifier of the family
=cut
sub family_id{
return shift->display_id(@_);
}
=head1 L<Bio::ClusterI> methods
=cut
=head2 display_id
Title : display_id
Usage :
Function: Get/set the display name or identifier for the cluster
Returns : a string
Args : optional, on set the display ID ( a string)
=cut
sub display_id{
my ($self,$id) = @_;
if($id){
$self->{'_cluster_id'} = $id;
}
return $self->{'_cluster_id'};
}
=head2 description
Title : description
Usage : $fam->description("POLYUBIQUITIN")
Function: get/set for the consensus description of the cluster
Returns : the description string
Args : Optional the description string
=cut
sub description{
my ($self,$desc) = @_;
if($desc){
$self->{'_description'} = $desc;
}
return $self->{'_description'};
}
=head2 get_members
Title : get_members
Usage : Valid criteria:
-common_name
-binomial
-ncbi_taxid
-organelle
-genus
$family->get_members(-common_name =>"human");
$family->get_members(-species =>"homo sapiens");
$family->get_members(-ncbi_taxid => 9606);
For now, multiple critieria are ORed.
Will return all members if no criteria are provided.
Function: get members using methods from L<Bio::Species>
the phylogenetic tree of the family.
Returns : an array of objects that are member of this family.
=cut
sub get_members {
my $self = shift;
my @ret;
if(@_) {
my %hash = @_;
foreach my $mem ( @{$self->{'_members'}} ) {
foreach my $key ( keys %hash){
my $method = $key;
$method=~s/-//g;
if($mem->can('species')){
my $species = $mem->species;
$species->can($method) ||
$self->throw("$method is an invalid criteria");
if($species->$method() eq $hash{$key} ){
push @ret, $mem;
}
}
}
}
return @ret;
}
return @{$self->{'_members'}};
}
=head2 size
Title : size
Usage : $fam->size();
Function: get/set for the size of the family,
calculated from the number of members
Returns : the size of the family
Args :
=cut
sub size {
my ($self) = @_;
return scalar(@{$self->{'_members'}});
}
=head2 cluster_score
Title : cluster_score
Usage : $fam->cluster_score(100);
Function: get/set for cluster_score which
represent the score in which the clustering
algorithm assigns to this cluster.
Returns : a number
=cut
sub cluster_score{
my ($self,$score) = @_;
if($score){
$self->{'_cluster_score'} = $score;
}
return $self->{'_cluster_score'};
}
=head1 Implementation specific methods
These are mostly for adding/removing/changing.
=cut
=head2 add_members
Title : add_members
Usage : $fam->add_member([$seq1,$seq1]);
Function: add members to a family
Returns :
Args : the member(s) to add, as an array or arrayref
=cut
sub add_members{
my ($self,@mems) = @_;
if (@mems) {
my $mem = shift(@mems);
if(ref($mem) eq "ARRAY"){
push @{$self->{'_members'}},@{$mem};
} else {
push @{$self->{'_members'}},$mem;
}
push @{$self->{'_members'}}, @mems;
}
return 1;
}
=head2 remove_members
Title : remove_members
Usage : $fam->remove_members();
Function: remove all members from a family
Returns : the previous array of members
Args : none
=cut
sub remove_members{
my ($self) = @_;
my $mems = $self->{'_members'};
$self->{'_members'} = [];
return @$mems;
}
#####################################################################
# aliases for naming consistency or other reasons #
#####################################################################
*flush_members = \&remove_members;
*add_member = \&add_members;
=head2 members
Title : members
Usage : $members = $fam->members([$seq1,$seq1]);
Function: Deprecated. Use add_members() or get_members() instead
=cut
sub members{
my $self = shift;
if(@_) {
# this is in set mode
$self->warn("setting members() in ".ref($self)." is deprecated.\n".
"Use add_members() instead.");
return $self->add_members(@_);
} else {
# get mode
$self->warn("members() in ".ref($self)." is deprecated.\n".
"Use get_members() instead.");
return $self->get_members();
}
}
1;
|