[Bio] / FigKernelPackages / FIGO.pm Repository:
ViewVC logotype

Annotation of /FigKernelPackages/FIGO.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.15 - (view) (download) (as text)

1 : overbeek 1.9 ########################################################################
2 : overbeek 1.1 #
3 :     # Copyright (c) 2003-2006 University of Chicago and Fellowship
4 :     # for Interpretations of Genomes. All Rights Reserved.
5 :     #
6 :     # This file is part of the SEED Toolkit.
7 :     #
8 :     # The SEED Toolkit is free software. You can redistribute
9 :     # it and/or modify it under the terms of the SEED Toolkit
10 :     # Public License.
11 :     #
12 :     # You should have received a copy of the SEED Toolkit Public License
13 :     # along with this program; if not write to the University of Chicago
14 :     # at info@ci.uchicago.edu or the Fellowship for Interpretation of
15 :     # Genomes at veronika@thefig.info or download a copy from
16 :     # http://www.theseed.org/LICENSE.TXT.
17 :     #
18 : overbeek 1.9 ########################################################################
19 :    
20 :     =head1 Overview
21 :    
22 :     This module is a set of packages encapsulating the SEED's core methods
23 :     using an "OOP-like" style.
24 :    
25 :     There are several modules clearly related to "individual genomes:"
26 :     FIGO, GenomeO, ContigO, FeatureO (and I<maybe> AnnotationO).
27 :    
28 :     There are also modules that deal with complex relationships between
29 :     pairs or sets of features in one, two, or more genomes,
30 :     rather than any particular single genome:
31 :     BBHO, CouplingO, SubsystemO, FunctionalRoleO, FigFamO.
32 :    
33 :     Finally, the methods in "Attribute" might in principle attach
34 :     "atributes" to any type of object.
35 :     (Likewise, in principle one might like to attach an "annotation"
36 :     to any type of object
37 :    
38 :     Four of the modules dealing with "genomes" have a reasonable clear
39 :     "implied heirarchy:"
40 :    
41 :     =over 4
42 :    
43 :     FIGO > GenomeO > ContigO > FeatureO
44 :    
45 :     =back
46 : overbeek 1.1
47 : overbeek 1.9 However, inheritance is B<NOT> implemented using the C<@ISA> mechanism,
48 :     because some methods deal with "pairwise" or "setwise" relations between objects
49 :     or other more complex relationships that do not naturally fit into any heirarchy ---
50 :     which would get us into the whole quagmire of "multiple inheritance."
51 :    
52 : overbeek 1.13 We have chosen to in many cases sidestep the entire issue of inheritance
53 :     via an I<ad hoc> mechanism:
54 : overbeek 1.9 If a "child" object needs access to its "ancestors'" methods,
55 :     we pass it references to its "ancestors" using subroutine arguments.
56 :     This is admittedly ugly, clumsy, and potentially error-prone ---
57 :     but it has the advantage that, unlike multiple inheritance,
58 :     we understand how to do it...
59 :    
60 :     MODULE DEPENDENCIES: FIG, FIG_Config, FigFams, SFXlate, SproutFIG, Tracer,
61 :     gjoparseblast, Data::Dumper.
62 :    
63 :     =cut
64 :    
65 :     ########################################################################
66 : overbeek 1.1 package FIGO;
67 : overbeek 1.9 ########################################################################
68 : overbeek 1.1 use strict;
69 :     use FIG;
70 :     use FIG_Config;
71 :     use SFXlate;
72 :     use SproutFIG;
73 :     use Tracer;
74 :     use Data::Dumper;
75 :     use FigFams;
76 : overbeek 1.3 use gjoparseblast;
77 : overbeek 1.1
78 : overbeek 1.9 =head1 FIGO
79 :    
80 :     The effective "base class" containing a few "top-level" methods.
81 :    
82 :     =cut
83 :    
84 : overbeek 1.4
85 :     =head3 new
86 :    
87 :     Constructs a new FIGO object.
88 :    
89 : overbeek 1.9 =over 4
90 : overbeek 1.4
91 :     =item USAGE:
92 :    
93 :     C<< my $figo = FIGO->new(); #...Subclass defaults to FIG >>
94 :    
95 :     C<< my $figo = FIGO->new('SPROUT'); #...Subclass is a SPROUT object >>
96 :    
97 :     =back
98 :    
99 :     =cut
100 :    
101 : overbeek 1.1 sub new {
102 :     my($class,$low_level) = @_;
103 :    
104 :     my $fig;
105 :     if ($low_level && ($low_level =~ /sprout/i))
106 :     {
107 :     $fig = new SproutFIG($FIG_Config::sproutDB, $FIG_Config::sproutData);
108 :     }
109 :     else
110 :     {
111 :     $fig = new FIG;
112 :     }
113 :    
114 :     my $self = {};
115 :     $self->{_fig} = $fig;
116 : overbeek 1.3 $self->{_tmp_dir} = $FIG_Config::temp;
117 : overbeek 1.1 return bless $self, $class;
118 :     }
119 :    
120 : overbeek 1.4
121 :    
122 :     =head3 genomes
123 :    
124 :     Returns a list of Taxonomy-IDs, possibly constrained by selection criteria.
125 :     (Default: Empty constraint returns all Tax-IDs in the SEED or SPROUT.)
126 :    
127 : overbeek 1.9 =over 4
128 : overbeek 1.4
129 :     =item USAGE:
130 :    
131 :     C<< my @tax_ids = $figo->genomes(); >>
132 :    
133 :     C<< my @tax_ids = $figo->genomes( @constraints ); >>
134 :    
135 :     =item @constraints
136 : overbeek 1.9
137 :     One or more element of: complete, prokaryotic, eukaryotic, bacterial, archaeal, nmpdr.
138 : overbeek 1.4
139 :     =item RETURNS: List of Tax-IDs.
140 :    
141 : overbeek 1.9 =item EXAMPLE:
142 :    
143 : overbeek 1.13 L<Display all complete, prokaryotic genomes>
144 : overbeek 1.4
145 :     =back
146 :    
147 :     =cut
148 :    
149 : overbeek 1.1 sub genomes {
150 :     my($self,@constraints) = @_;
151 :     my $fig = $self->{_fig};
152 :    
153 :     my %constraints = map { $_ => 1 } @constraints;
154 :     my @genomes = ();
155 :    
156 :     if ($constraints{complete})
157 :     {
158 :     @genomes = $fig->genomes('complete');
159 :     }
160 :     else
161 :     {
162 :     @genomes = $fig->genomes;
163 :     }
164 :    
165 :     if ($constraints{prokaryotic})
166 :     {
167 :     @genomes = grep { $fig->is_prokaryotic($_) } @genomes;
168 :     }
169 :    
170 :     if ($constraints{eukaryotic})
171 :     {
172 :     @genomes = grep { $fig->is_eukaryotic($_) } @genomes;
173 :     }
174 :    
175 :     if ($constraints{bacterial})
176 :     {
177 :     @genomes = grep { $fig->is_bacterial($_) } @genomes;
178 :     }
179 :    
180 :     if ($constraints{archaeal})
181 :     {
182 :     @genomes = grep { $fig->is_archaeal($_) } @genomes;
183 :     }
184 :    
185 :     if ($constraints{nmpdr})
186 :     {
187 :     @genomes = grep { $fig->is_NMPDR_genome($_) } @genomes;
188 :     }
189 :    
190 :     return map { &GenomeO::new('GenomeO',$self,$_) } @genomes;
191 :     }
192 :    
193 : overbeek 1.4
194 :    
195 :     =head3 subsystems
196 :    
197 : overbeek 1.9 =over 4
198 : overbeek 1.4
199 :     =item RETURNS:
200 :    
201 : overbeek 1.9 List of all subsystems.
202 :    
203 :     =item EXAMPLE:
204 :    
205 : overbeek 1.13 L<Accessing Subsystem data>
206 : overbeek 1.4
207 :     =back
208 :    
209 :     =cut
210 :    
211 : overbeek 1.1 sub subsystems {
212 :     my($self) = @_;
213 :     my $fig = $self->{_fig};
214 :    
215 :     return map { &SubsystemO::new('SubsystemO',$self,$_) } $fig->all_subsystems;
216 :     }
217 :    
218 : overbeek 1.4
219 :     =head3 functional_roles
220 :    
221 :     (Not yet implemented)
222 :    
223 : overbeek 1.9 =over
224 : overbeek 1.4
225 :     =item RETURNS:
226 :    
227 :     =item EXAMPLE:
228 :    
229 :     =back
230 :    
231 :     =cut
232 :    
233 : overbeek 1.1 sub functional_roles {
234 :     my($self) = @_;
235 :     my $fig = $self->{_fig};
236 :    
237 :     my @functional_roles = ();
238 :    
239 :     return @functional_roles;
240 :     }
241 :    
242 : overbeek 1.4
243 :    
244 :     =head3 all_figfams
245 :    
246 :     Returns a list of all FIGfam objects.
247 :    
248 : overbeek 1.9 =over 4
249 :    
250 :     =item USAGE:
251 :    
252 : overbeek 1.13 C<< foreach $fam ($figO->all_figfams) { #...Do something } >>
253 : overbeek 1.9
254 :     =item RETURNS:
255 : overbeek 1.4
256 : overbeek 1.9 List of FIGfam Objects
257 : overbeek 1.4
258 : overbeek 1.9 =item EXAMPLE:
259 : overbeek 1.4
260 : overbeek 1.13 L<Accessing FIGfams>
261 : overbeek 1.4
262 :     =back
263 :    
264 :     =cut
265 :    
266 : overbeek 1.1 sub all_figfams {
267 :     my($self) = @_;
268 :     my $fig = $self->{_fig};
269 :     my $fams = new FigFams($fig);
270 :     return map { &FigFamO::new('FigFamO',$self,$_) } $fams->all_families;
271 :     }
272 :    
273 : overbeek 1.4
274 :    
275 :     =head3 family_containing
276 :    
277 : overbeek 1.9 =over 4
278 : overbeek 1.4
279 : overbeek 1.9 =item USAGE:
280 : overbeek 1.4
281 : overbeek 1.13 C<< my ($fam, $sims) = $figO->family_containing($seq); >>
282 : overbeek 1.4
283 : overbeek 1.9 =item $seq:
284 :    
285 :     A protein translation string.
286 :    
287 :     =item RETURNS:
288 :    
289 : overbeek 1.4 $fam: A FIGfam Object.
290 : overbeek 1.9
291 : overbeek 1.4 $sims: A set of similarity objects.
292 :    
293 :     =item EXAMPLE: L<Placing a sequence into a FIGfam>
294 :    
295 :     =back
296 :    
297 :     =cut
298 :    
299 : overbeek 1.1 sub family_containing {
300 :     my($self,$seq) = @_;
301 :    
302 :     my $fig = $self->{_fig};
303 :     my $fams = new FigFams($fig);
304 :     my($fam,$sims) = $fams->place_in_family($seq);
305 :     if ($fam)
306 :     {
307 :     return (&FigFamO::new('FigFamO',$self,$fam->family_id),$sims);
308 :     }
309 :     else
310 :     {
311 :     return undef;
312 :     }
313 :     }
314 :    
315 : overbeek 1.4
316 :     ########################################################################
317 : overbeek 1.1 package GenomeO;
318 : overbeek 1.4 ########################################################################
319 :     use Data::Dumper;
320 :    
321 :     =head1 GenomeO
322 :    
323 :     =cut
324 :    
325 : overbeek 1.13
326 : overbeek 1.4 =head3 new
327 :    
328 :     Constructor of GenomeO objects.
329 : overbeek 1.1
330 : overbeek 1.9 =over 4
331 : overbeek 1.4
332 :     =item USAGE:
333 :    
334 : overbeek 1.13 C<< my $org = GenomeO->new($figo, $tax_id); >>
335 : overbeek 1.9
336 :     =item RETURNS:
337 :    
338 :     A new GenomeO object.
339 : overbeek 1.4
340 :     =back
341 :    
342 :     =cut
343 : overbeek 1.1
344 :     sub new {
345 :     my($class,$figO,$genomeId) = @_;
346 :    
347 :     my $self = {};
348 :     $self->{_figO} = $figO;
349 :     $self->{_id} = $genomeId;
350 :     return bless $self, $class;
351 :     }
352 :    
353 : overbeek 1.4
354 :    
355 :     =head3 id
356 :    
357 : overbeek 1.9 =over 4
358 :    
359 :     =item USAGE:
360 : overbeek 1.4
361 : overbeek 1.13 C<< my $tax_id = $org->id(); >>
362 : overbeek 1.9
363 :     =item RETURNS:
364 : overbeek 1.4
365 : overbeek 1.9 Taxonomy-ID of GenomeO object.
366 : overbeek 1.4
367 :     =back
368 :    
369 :     =cut
370 :    
371 : overbeek 1.1 sub id {
372 :     my($self) = @_;
373 :    
374 :     return $self->{_id};
375 :     }
376 :    
377 : overbeek 1.4
378 :    
379 :     =head3 genus_species
380 :    
381 : overbeek 1.9 =over 4
382 : overbeek 1.4
383 : overbeek 1.9 =item USAGE:
384 :    
385 : overbeek 1.13 C<< $gs = $genome->genus_species(); >>
386 : overbeek 1.9
387 :     =item RETURNS:
388 : overbeek 1.4
389 : overbeek 1.9 Genus-species-strain string
390 : overbeek 1.4
391 :     =back
392 :    
393 :     =cut
394 :    
395 : overbeek 1.1 sub genus_species {
396 :     my($self) = @_;
397 :    
398 :     my $fig = $self->{_figO}->{_fig};
399 :     return $fig->genus_species($self->{_id});
400 :     }
401 :    
402 : overbeek 1.4
403 :     =head3 contigs_of
404 :    
405 : overbeek 1.9 =over 4
406 :    
407 :     =item RETURNS:
408 :    
409 :     List of C<contig> objects contained in a C<GenomeO> object.
410 : overbeek 1.4
411 : overbeek 1.9 =item EXAMPLE:
412 : overbeek 1.4
413 : overbeek 1.13 L<Show how to access contigs and extract sequence>
414 : overbeek 1.4
415 :     =back
416 :    
417 :     =cut
418 :    
419 : overbeek 1.1 sub contigs_of {
420 :     my($self) = @_;
421 :    
422 :     my $figO = $self->{_figO};
423 :     my $fig = $figO->{_fig};
424 :     return map { &ContigO::new('ContigO',$figO,$self->id,$_) } $fig->contigs_of($self->id);
425 :     }
426 :    
427 : overbeek 1.4
428 :    
429 :     =head3 features_of
430 :    
431 :     =cut
432 :    
433 : overbeek 1.1 sub features_of {
434 :     my($self,$type) = @_;
435 :    
436 :     my $figO = $self->{_figO};
437 :     my $fig = $figO->{_fig};
438 :    
439 :     return map { &FeatureO::new('FeatureO',$figO,$_) } $fig->all_features($self->id,$type);
440 :     }
441 :    
442 : overbeek 1.4
443 :     =head3 display
444 :    
445 :     Prints the genus, species, and strain information about a genome to STDOUT.
446 :    
447 : overbeek 1.9 =over 4
448 :    
449 :     =item USAGE:
450 :    
451 : overbeek 1.13 C<< $genome->display(); >>
452 : overbeek 1.4
453 : overbeek 1.9 =item RETURNS:
454 : overbeek 1.4
455 : overbeek 1.9 (Void)
456 : overbeek 1.4
457 :     =back
458 :    
459 :     =cut
460 :    
461 : overbeek 1.1 sub display {
462 :     my($self) = @_;
463 :    
464 :     print join("\t",("Genome",$self->id,$self->genus_species)),"\n";
465 :     }
466 :    
467 : overbeek 1.4
468 :    
469 :     ########################################################################
470 : overbeek 1.1 package ContigO;
471 : overbeek 1.4 ########################################################################
472 :     use Data::Dumper;
473 :    
474 :     =head1 ContigO
475 :    
476 :     Methods for working with DNA sequence objects.
477 :    
478 :     =cut
479 :    
480 :     =head3 new
481 :    
482 :     Contig constructor.
483 : overbeek 1.1
484 : overbeek 1.9 =over 4
485 : overbeek 1.4
486 :     =item USAGE:
487 :    
488 : overbeek 1.13 C<< $contig = ContigO->new( $figO, $genomeId, $contigId); >>
489 : overbeek 1.4
490 : overbeek 1.9 =item $figO:
491 : overbeek 1.4
492 : overbeek 1.9 Parent FIGO object.
493 : overbeek 1.4
494 : overbeek 1.9 =item $genomeId:
495 :    
496 :     Taxon-ID for the genome the contig is from.
497 :    
498 :     =item $contigId:
499 :    
500 :     Identifier for the contig
501 :    
502 :     =item RETURNS:
503 :    
504 :     A "ContigO" object.
505 : overbeek 1.4
506 :     =back
507 :    
508 :     =cut
509 : overbeek 1.1
510 :     sub new {
511 :     my($class,$figO,$genomeId,$contigId) = @_;
512 :    
513 :     my $self = {};
514 :     $self->{_figO} = $figO;
515 :     $self->{_id} = $contigId;
516 :     $self->{_genome} = $genomeId;
517 :     return bless $self, $class;
518 :     }
519 :    
520 : overbeek 1.4
521 :    
522 :     =head3 id
523 :    
524 : overbeek 1.9 =over 4
525 : overbeek 1.4
526 : overbeek 1.9 =item RETURNS:
527 :    
528 :     Sequence ID string of "ContigO" object
529 : overbeek 1.4
530 :     =back
531 :    
532 :     =cut
533 :    
534 : overbeek 1.1 sub id {
535 :     my($self) = @_;
536 :    
537 :     return $self->{_id};
538 :     }
539 :    
540 : overbeek 1.4
541 :     =head3 genome
542 :    
543 : overbeek 1.9 =over 4
544 : overbeek 1.4
545 : overbeek 1.9 =item USAGE:
546 :    
547 : overbeek 1.13 C<< my $tax_id = $contig->genome->id(); >>
548 : overbeek 1.4
549 : overbeek 1.9 =item RETURNS:
550 :    
551 :     Tax-ID of the GenomeO object containing the contig object.
552 : overbeek 1.4
553 :     =back
554 :    
555 :     =cut
556 :    
557 : overbeek 1.1 sub genome {
558 :     my($self) = @_;
559 :    
560 : overbeek 1.10 my $figO = $self->{_figO};
561 :     return new GenomeO($figO,$self->{_genome});
562 : overbeek 1.1 }
563 :    
564 : overbeek 1.4
565 :    
566 :     =head3 contig_length
567 :    
568 : overbeek 1.9 =over 4
569 : overbeek 1.4
570 :     =item USAGE:
571 : overbeek 1.9
572 : overbeek 1.13 C<< my $len = $contig->contig_length(); >>
573 : overbeek 1.4
574 : overbeek 1.9 =item RETURNS:
575 :    
576 :     Length of contig's DNA sequence.
577 : overbeek 1.4
578 :     =back
579 :    
580 :     =cut
581 :    
582 : overbeek 1.1 sub contig_length {
583 :     my($self) = @_;
584 :    
585 :     my $fig = $self->{_figO}->{_fig};
586 : overbeek 1.11 my $contig_lengths = $fig->contig_lengths($self->genome->id);
587 : overbeek 1.1 return $contig_lengths->{$self->id};
588 :     }
589 :    
590 : overbeek 1.4
591 :     =head3 dna_seq
592 :    
593 : overbeek 1.9 =over 4
594 : overbeek 1.4
595 :     =item USAGE:
596 : overbeek 1.9
597 : overbeek 1.13 C<< my $seq = $contig->dna_seq(beg, $end); >>
598 : overbeek 1.4
599 : overbeek 1.9 =item $beg:
600 :    
601 :     Begining point of DNA subsequence
602 : overbeek 1.4
603 : overbeek 1.9 =item $end:
604 : overbeek 1.4
605 : overbeek 1.9 End point of DNA subsequence
606 : overbeek 1.4
607 : overbeek 1.9 =item RETURNS:
608 :    
609 :     string of DNA sequence running from $beg to $end
610 :     (NOTE: if $beg > $end, returns reverse complement of DNA subsequence.)
611 : overbeek 1.4
612 :     =back
613 :    
614 :     =cut
615 :    
616 : overbeek 1.1 sub dna_seq {
617 :     my($self,$beg,$end) = @_;
618 :    
619 :     my $fig = $self->{_figO}->{_fig};
620 :     my $max = $self->contig_length;
621 :     if (($beg && (&FIG::between(1,$beg,$max))) &&
622 :     ($end && (&FIG::between(1,$end,$max))))
623 :     {
624 : overbeek 1.11 return $fig->dna_seq($self->genome->id,join("_",($self->id,$beg,$end)));
625 : overbeek 1.1 }
626 :     else
627 :     {
628 :     return undef;
629 :     }
630 :     }
631 :    
632 : overbeek 1.4
633 :     =head3 display
634 :    
635 :     Prints summary information about a "ContigO" object to STDOUT:
636 :    
637 :     Genus, species, strain
638 :    
639 :     Contig ID
640 :    
641 :     Contig length
642 :    
643 : overbeek 1.9 =over 4
644 :    
645 :     =item RETURNS:
646 : overbeek 1.4
647 : overbeek 1.9 (Void)
648 : overbeek 1.4
649 :     =back
650 :    
651 :     =cut
652 :    
653 : overbeek 1.1 sub display {
654 :     my($self) = @_;
655 :    
656 : overbeek 1.11 print join("ContigO",$self->genome->id,$self->id,$self->contig_length),"\n";
657 : overbeek 1.1 }
658 :    
659 : overbeek 1.10 sub features_in_region {
660 :     my($self,$beg,$end) = @_;
661 :     my $figO = $self->{_figO};
662 :     my $fig = $figO->{_fig};
663 : overbeek 1.4
664 : overbeek 1.10 my($features) = $fig->genes_in_region($self->genome->id,$self->id,$beg,$end);
665 :     return map { new FeatureO($figO,$_) } @$features;
666 :     }
667 : overbeek 1.4
668 : overbeek 1.13
669 :    
670 : overbeek 1.4 ########################################################################
671 : overbeek 1.1 package FeatureO;
672 : overbeek 1.4 ########################################################################
673 :     use Data::Dumper;
674 :    
675 :     =head1 FeatureO
676 :    
677 : overbeek 1.9 Methods for working with features on "ContigO" objects.
678 :    
679 : overbeek 1.4 =cut
680 :    
681 : overbeek 1.13
682 : overbeek 1.9 =head3 new
683 : overbeek 1.4
684 :     Constructor of "FeatureO" objects
685 :    
686 : overbeek 1.13 =over 4
687 :    
688 :     =item USAGE:
689 :    
690 :     C<< my $feature = FeatureO->new( $figO, $fid ); >>
691 :    
692 :     =item C<$figO>:
693 :    
694 :     "Base" FIGO object.
695 :    
696 :     =item C<$fid>:
697 :    
698 :     Feature-ID for new feature
699 :    
700 :     =item RETURNS:
701 :    
702 :     A newly created "FeatureO" object.
703 :    
704 :     =back
705 :    
706 : overbeek 1.4 =cut
707 : overbeek 1.1
708 :     sub new {
709 :     my($class,$figO,$fid) = @_;
710 :    
711 :     ($fid =~ /^fig\|\d+\.\d+\.[^\.]+\.\d+$/) || return undef;
712 :     my $self = {};
713 :     $self->{_figO} = $figO;
714 :     $self->{_id} = $fid;
715 :     return bless $self, $class;
716 :     }
717 :    
718 : overbeek 1.4
719 : overbeek 1.13
720 : overbeek 1.4 =head3 id
721 :    
722 : overbeek 1.13 =over 4
723 :    
724 :     =item USAGE:
725 :    
726 :     C<< my $fid = $feature->id(); >>
727 :    
728 :     =item RETURNS:
729 :    
730 :     The FID (Feature ID) of a "FeatureO" object.
731 :    
732 :     =back
733 :    
734 : overbeek 1.4 =cut
735 :    
736 : overbeek 1.1 sub id {
737 :     my($self) = @_;
738 :    
739 :     return $self->{_id};
740 :     }
741 :    
742 : overbeek 1.4
743 :    
744 :     =head3 genome
745 :    
746 : overbeek 1.13 =over 4
747 :    
748 :     =item USAGE:
749 :    
750 :     C<< my $taxid = $feature->genome(); >>
751 :    
752 :     =item RETURNS:
753 :    
754 :     The TAxon-ID for the "GenomeO" object containg the feature.
755 :    
756 :     =back
757 :    
758 : overbeek 1.4 =cut
759 :    
760 : overbeek 1.1 sub genome {
761 :     my($self) = @_;
762 : overbeek 1.12 my $figO = $self->{_figO};
763 : overbeek 1.1 $self->id =~ /^fig\|(\d+\.\d+)/;
764 : overbeek 1.12 return new GenomeO($figO,$1);
765 : overbeek 1.1 }
766 :    
767 : overbeek 1.4
768 :    
769 :     =head3 type
770 :    
771 : overbeek 1.13 =over 4
772 :    
773 :     =item USAGE:
774 :    
775 :     C<< my $feature_type = $feature->type(); >>
776 :    
777 :     =item RETURNS:
778 :    
779 :     The feature object's "type" (e.g., "peg," "rna," etc.)
780 :    
781 :     =back
782 :    
783 : overbeek 1.4 =cut
784 :    
785 : overbeek 1.1 sub type {
786 :     my($self) = @_;
787 :    
788 :     $self->id =~ /^fig\|\d+\.\d+\.([^\.]+)/;
789 :     return $1;
790 :     }
791 :    
792 : overbeek 1.4
793 :    
794 : overbeek 1.13 =head3 location
795 :    
796 :     =over 4
797 : overbeek 1.4
798 : overbeek 1.13 =item USAGE:
799 :    
800 :     C<< my $loc = $feature->location(); >>
801 :    
802 :     =item RETURNS:
803 :    
804 :     A string representing the feature object's location on the genome's DNA,
805 :     in SEED "tbl format" (i.e., "contig_beging_end").
806 :    
807 :     =back
808 : overbeek 1.4
809 :     =cut
810 :    
811 : overbeek 1.1 sub location {
812 :     my($self) = @_;
813 :    
814 :     my $fig = $self->{_figO}->{_fig};
815 :     return scalar $fig->feature_location($self->id);
816 :     }
817 :    
818 : overbeek 1.13
819 :     =head3 contig
820 :    
821 :     =over 4
822 :    
823 :     =item USAGE:
824 :    
825 :     C<< my $contig = $feature->contig(); >>
826 :    
827 :     =item RETURNS:
828 :    
829 :     A "ContigO" object to access the contig data
830 :     for the contig the feature is on.
831 :    
832 :     =back
833 :    
834 :     =cut
835 :    
836 : overbeek 1.12 sub contig {
837 :     my($self) = @_;
838 :    
839 :     my $figO = $self->{_figO};
840 :     my $loc = $self->location;
841 :     my $genomeID = $self->genome->id;
842 :     return ($loc =~ /^(\S+)_\d+_\d+$/) ? new ContigO($figO,$genomeID,$1) : undef;
843 :     }
844 :    
845 : overbeek 1.13
846 :    
847 :     =head3 begin
848 :    
849 :     =over 4
850 :    
851 :     =item USAGE:
852 :    
853 :     C<< my $beg = $feature->begin(); >>
854 :    
855 :     =item RETURNS:
856 :    
857 :     The numerical coordinate of the first base of the feature.
858 :    
859 :     =back
860 :    
861 :     =cut
862 :    
863 : overbeek 1.12 sub begin {
864 :     my($self) = @_;
865 :    
866 :     my $loc = $self->location;
867 :     return ($loc =~ /^\S+_(\d+)_\d+$/) ? $1 : undef;
868 :     }
869 : overbeek 1.4
870 : overbeek 1.13
871 :    
872 :     =head3 end
873 :    
874 :     =over 4
875 :    
876 :     =item USAGE:
877 :    
878 :     C<< my $end = $feature->end(); >>
879 :    
880 :     =item RETURNS:
881 :    
882 :     The numerical coordinate of the last base of the feature.
883 :    
884 :     =back
885 :    
886 :     =cut
887 :    
888 : overbeek 1.12 sub end {
889 :     my($self) = @_;
890 :    
891 :     my $loc = $self->location;
892 :     return ($loc =~ /^\S+_\d+_(\d+)$/) ? $1 : undef;
893 :     }
894 : overbeek 1.4
895 : overbeek 1.13
896 :    
897 : overbeek 1.4 =head3 dna_seq
898 :    
899 : overbeek 1.13 =over 4
900 :    
901 :     =item USAGE:
902 :    
903 :     C<< my $dna_seq = $feature->dna_seq(); >>
904 :    
905 :     =item RETURNS:
906 :    
907 :     A string contining the DNA subsequence of the contig
908 :     running from the first to the last base of the feature.
909 :    
910 :     If ($beg > $end), the reverse complement subsequence is returned.
911 :    
912 :     =back
913 :    
914 : overbeek 1.4 =cut
915 :    
916 : overbeek 1.1 sub dna_seq {
917 :     my($self) = @_;
918 :    
919 :     my $fig = $self->{_figO}->{_fig};
920 :     my $fid = $self->id;
921 :     my @loc = $fig->feature_location($fid);
922 :     return $fig->dna_seq(&FIG::genome_of($fid),@loc);
923 :     }
924 :    
925 : overbeek 1.4
926 :    
927 :     =head3 prot_seq
928 :    
929 : overbeek 1.13 =over 4
930 :    
931 :     =item USAGE:
932 :    
933 :     C<< my $dna_seq = $feature->prot_seq(); >>
934 :    
935 :     =item RETURNS:
936 :    
937 :     A string contining the protein translation of the feature (if it exists),
938 :     or the "undef" value if the feature does not exist or is not a PEG.
939 :    
940 :     =back
941 :    
942 : overbeek 1.4 =cut
943 :    
944 : overbeek 1.1 sub prot_seq {
945 :     my($self) = @_;
946 :    
947 :     ($self->type eq "peg") || return undef;
948 :     my $fig = $self->{_figO}->{_fig};
949 :     my $fid = $self->id;
950 :     return $fig->get_translation($fid);
951 :     }
952 :    
953 : overbeek 1.4
954 :    
955 :     =head3 function_of
956 :    
957 : overbeek 1.13 =over 4
958 :    
959 :     =item USAGE:
960 :    
961 :     C<< my $func = $feature->function_of(); >>
962 :    
963 :     =item RETURNS:
964 :    
965 :     A string containing the function assigned to the feature,
966 :     or the "undef" value if no function has been assigned.
967 :    
968 :     =back
969 :    
970 : overbeek 1.4 =cut
971 :    
972 : overbeek 1.1 sub function_of {
973 :     my($self) = @_;
974 :    
975 :     my $fig = $self->{_figO}->{_fig};
976 :     my $fid = $self->id;
977 :     return scalar $fig->function_of($fid);
978 :     }
979 :    
980 : overbeek 1.4
981 :    
982 :     =head3 coupled_to
983 :    
984 : overbeek 1.13 =over 4
985 :    
986 :     =item USAGE:
987 :    
988 :     C<< my @coupled_features = $feature->coupled_to(); >>
989 :    
990 :     =item RETURNS:
991 :    
992 :     A list of L<CouplingO> objects describing the evidence for functional coupling
993 :     between this feature and other nearby features.
994 :    
995 :     =back
996 :    
997 : overbeek 1.4 =cut
998 :    
999 : overbeek 1.1 sub coupled_to {
1000 :     my($self) = @_;
1001 :    
1002 : overbeek 1.13 ($self->type eq "peg") || return ();
1003 : overbeek 1.1 my $figO = $self->{_figO};
1004 :     my $fig = $figO->{_fig};
1005 :     my $peg1 = $self->id;
1006 :     my @coupled = ();
1007 :     foreach my $tuple ($fig->coupled_to($peg1))
1008 :     {
1009 :     my($peg2,$sc) = @$tuple;
1010 :     push(@coupled, &CouplingO::new('CouplingO',$figO,$peg1,$peg2,$sc));
1011 :     }
1012 :     return @coupled;
1013 :     }
1014 :    
1015 : overbeek 1.4
1016 :    
1017 :     =head3 annotations
1018 :    
1019 : overbeek 1.13 =over 4
1020 :    
1021 :     =item USAGE:
1022 :    
1023 :     C<< my @annot_list = $feature->annotations(); >>
1024 :    
1025 :     =item RETURNS:
1026 :    
1027 :     A list of L<AnnotationO> objects allowing access to the annotations for this feature.
1028 :    
1029 :     =back
1030 :    
1031 : overbeek 1.4 =cut
1032 :    
1033 : overbeek 1.1 sub annotations {
1034 :     my($self) = @_;
1035 :    
1036 :     my $figO = $self->{_figO};
1037 :     my $fig = $figO->{_fig};
1038 :    
1039 :     return map { &AnnotationO::new('AnnotationO',@$_) } $fig->feature_annotations($self->id,1);
1040 :     }
1041 :    
1042 : overbeek 1.13
1043 :     =head3 in_subsystems
1044 :    
1045 :     =over 4
1046 :    
1047 :     =item USAGE:
1048 :    
1049 :     C<< my @subsys_list = $feature->in_subsystems(); >>
1050 :    
1051 :     =item RETURNS:
1052 :    
1053 :     A list of L<SubsystemO> objects allowing access to the subsystems
1054 :     that this feature particupates in.
1055 :    
1056 :     =back
1057 :    
1058 :     =cut
1059 :    
1060 : overbeek 1.5 sub in_subsystems {
1061 :     my($self) = @_;
1062 :     my $figO = $self->{_figO};
1063 :     my $fig = $figO->{_fig};
1064 :    
1065 :     return map { new SubsystemO($figO,$_) } $fig->peg_to_subsystems($self->id);
1066 :     }
1067 : overbeek 1.4
1068 :    
1069 :     =head3 possibly_truncated
1070 :    
1071 : overbeek 1.13 =over 4
1072 :    
1073 :     =item USAGE:
1074 :    
1075 :     C<< my $trunc = $feature->possibly_truncated(); >>
1076 :    
1077 :     =item RETURNS:
1078 :    
1079 :     Boolean C<TRUE> if the feature may be truncated;
1080 :     boolean C<FALSE> otherwise.
1081 :    
1082 :     =back
1083 :    
1084 : overbeek 1.4 =cut
1085 :    
1086 : overbeek 1.3 sub possibly_truncated {
1087 :     my($self) = @_;
1088 :     my $figO = $self->{_figO};
1089 :     my $fig = $figO->{_fig};
1090 :    
1091 :     return $fig->possibly_truncated($self->id);
1092 :     }
1093 :    
1094 : overbeek 1.4
1095 :    
1096 :     =head3 possible_frameshift
1097 :    
1098 : overbeek 1.13 =over 4
1099 :    
1100 :     =item USAGE:
1101 :    
1102 :     C<< my $fs = $feature->possible_frameshift(); >>
1103 :    
1104 :     =item RETURNS:
1105 :    
1106 :     Boolean C<TRUE> if the feature may be a frameshifted fragment;
1107 :     boolean C<FALSE> otherwise.
1108 :    
1109 :     (NOTE: This is a crude prototype implementation,
1110 :     and is mostly as an example of how to code using FIGO.)
1111 :    
1112 :     =back
1113 :    
1114 : overbeek 1.4 =cut
1115 :    
1116 : overbeek 1.3 sub possible_frameshift {
1117 :     my($self) = @_;
1118 :     my $figO = $self->{_figO};
1119 :     my($tmp_dir) = $figO->{_tmp_dir};
1120 :    
1121 :     if (! $self->possibly_truncated)
1122 :     {
1123 :     my @sims = $self->sims( -max => 1, -cutoff => 1.0e-50);
1124 :     if (my $sim = shift @sims)
1125 :     {
1126 :     my $peg2 = $sim->id2;
1127 :     my $ln1 = $sim->ln1;
1128 :     my $ln2 = $sim->ln2;
1129 :     my $b2 = $sim->b2;
1130 :     my $e2 = $sim->e2;
1131 :     my $adjL = 100 + (($b2-1) * 3);
1132 :     my $adjR = 100 + (($ln2 - $e2) * 3);
1133 :     if ($ln2 > (1.2 * $ln1))
1134 :     {
1135 :     my $loc = $self->location;
1136 :     if ($loc =~ /^(\S+)_(\d+)_(\d+)/)
1137 :     {
1138 :     my $contig = $1;
1139 :     my $beg = $2;
1140 :     my $end = $3;
1141 : overbeek 1.11 my $contigO = new ContigO($figO,$self->genome->id,$contig);
1142 : overbeek 1.3 my $begA = &max(1,$beg - $adjL);
1143 :     my $endA = &min($end+$adjR,$contigO->contig_length);
1144 :     my $dna = $contigO->dna_seq($begA,$endA);
1145 :     open(TMP,">$tmp_dir/tmp_dna") || die "couild not open tmp_dna";
1146 :     print TMP ">dna\n$dna\n";
1147 :     close(TMP);
1148 :    
1149 :     my $peg2O = new FeatureO($figO,$peg2);
1150 :     my $prot = $peg2O->prot_seq;
1151 :     open(TMP,">$tmp_dir/tmp_prot") || die "could not open tmp_prot";
1152 :     print TMP ">tmp_prot\n$prot\n";
1153 :     close(TMP);
1154 :     &run("formatdb -i $tmp_dir/tmp_dna -pF");
1155 :     open(BLAST,"blastall -i $tmp_dir/tmp_prot -d $tmp_dir/tmp_dna -p tblastn -FF -e 1.0e-50 |")
1156 :     || die "could not blast";
1157 :    
1158 :     my $db_seq_out = &gjoparseblast::next_blast_subject(\*BLAST,1);
1159 :     my @hsps = sort { $a->[0] <=> $b->[0] }
1160 :     map { [$_->[9],$_->[10],$_->[12],$_->[13]] }
1161 :     grep { $_->[1] < 1.0e-50 }
1162 :     @{$db_seq_out->[6]};
1163 :     my @prot = map { [$_->[0],$_->[1]] } @hsps;
1164 :     my @dna = map { [$_->[2],$_->[3]] } @hsps;
1165 : overbeek 1.14 if (&covers(\@prot,length($prot),3,0) && &covers(\@dna,3*length($prot),9,1))
1166 : overbeek 1.3 {
1167 :     return 1;
1168 :     }
1169 :     }
1170 :     }
1171 :     }
1172 :     }
1173 :     return 0;
1174 :     }
1175 :    
1176 : overbeek 1.4
1177 :    
1178 :     =head3 run
1179 :    
1180 : overbeek 1.13 (Note: This function should be considered "PRIVATE")
1181 :    
1182 :     =over 4
1183 :    
1184 :     =item FUNCTION:
1185 :    
1186 :     Passes a string containing a command to be execture by the "system" shell command.
1187 :    
1188 :     =item USAGE:
1189 :    
1190 :     C<< $feature->run($cmd); >>
1191 :    
1192 :     =item RETURNS:
1193 :    
1194 :     Nil if the execution of C<$cmd> was successful;
1195 :     aborts with traceback if C<$cmd> fails.
1196 : overbeek 1.4
1197 : overbeek 1.13 =back
1198 :    
1199 :     =cut
1200 :    
1201 :     sub run {
1202 : overbeek 1.3 my($cmd) = @_;
1203 :     (system($cmd) == 0) || Confess("FAILED: $cmd");
1204 :     }
1205 :    
1206 : overbeek 1.4
1207 :    
1208 :     =head3 max
1209 :    
1210 : overbeek 1.13 (Note: This function should be considered "PRIVATE")
1211 :    
1212 :     =over 4
1213 :    
1214 :     =item USAGE:
1215 :    
1216 :     C<< my $max = $feature->max($x, $y); >>
1217 :    
1218 :     =item C<$x>
1219 :    
1220 :     Numerical value.
1221 :    
1222 :     =item C<$y>
1223 :    
1224 :     Numerical value.
1225 :    
1226 :     =items RETURNS:
1227 :    
1228 :     The larger of the two numerical values C<$x> and C<$y>.
1229 :    
1230 :     =back
1231 :    
1232 : overbeek 1.4 =cut
1233 :    
1234 : overbeek 1.3 sub max {
1235 :     my($x,$y) = @_;
1236 :     return ($x < $y) ? $y : $x;
1237 :     }
1238 :    
1239 : overbeek 1.4
1240 :    
1241 :     =head3 min
1242 :    
1243 : overbeek 1.13 (Note: This function should be considered "PRIVATE")
1244 :    
1245 :     =over 4
1246 :    
1247 :     =item USAGE:
1248 :    
1249 :     C<< my $min = $feature->min($x, $y); >>
1250 :    
1251 :     =item C<$x>
1252 :    
1253 :     Numerical value.
1254 :    
1255 :     =item C<$y>
1256 :    
1257 :     Numerical value.
1258 :    
1259 :     =items RETURNS:
1260 :    
1261 :     The smaller of the two numerical values C<$x> and C<$y>.
1262 :    
1263 :     =back
1264 :    
1265 : overbeek 1.4 =cut
1266 :    
1267 : overbeek 1.3 sub min {
1268 :     my($x,$y) = @_;
1269 :     return ($x < $y) ? $x : $y;
1270 :     }
1271 :    
1272 : overbeek 1.4
1273 :    
1274 :     =head3 covers
1275 :    
1276 :     =cut
1277 :    
1278 : overbeek 1.3 sub covers {
1279 : overbeek 1.14 my($hsps,$ln,$diff,$must_shift) = @_;
1280 : overbeek 1.3
1281 :     my $hsp1 = shift @$hsps;
1282 :     my $hsp2;
1283 : overbeek 1.15 my $merged = 0;
1284 : overbeek 1.14 while ($hsp1 && ($hsp2 = shift @$hsps) &&
1285 :     ($must_shift ? &diff_frames($hsp1,$hsp2) : 1) &&
1286 : overbeek 1.15 ($hsp1 = &merge($hsp1,$hsp2,$diff))) { $merged = 1 }
1287 :     return ($merged && $hsp1 && (($hsp1->[1] - $hsp1->[0]) > (0.9 * $ln)));
1288 : overbeek 1.3 }
1289 :    
1290 : overbeek 1.14 sub diff_frames {
1291 :     my($hsp1,$hsp2) = @_;
1292 :     return (($hsp1->[0] % 3) != ($hsp2->[0] % 3));
1293 :     }
1294 : overbeek 1.4
1295 :     =head3 merge
1296 :    
1297 :     =cut
1298 :    
1299 : overbeek 1.3 sub merge {
1300 :     my($hsp1,$hsp2,$diff) = @_;
1301 :    
1302 :     my($b1,$e1) = @$hsp1;
1303 :     my($b2,$e2) = @$hsp2;
1304 :     return (($e2 > $e1) && (abs($b2-$e1) <= $diff)) ? [$b1,$e2] : undef;
1305 :     }
1306 :    
1307 : overbeek 1.4
1308 :    
1309 :     =head3 sims
1310 :    
1311 :     =cut
1312 :    
1313 : overbeek 1.2 use Sim;
1314 :     sub sims {
1315 :     my($self,%args) = @_;
1316 :    
1317 :     my $figO = $self->{_figO};
1318 :     my $fig = $figO->{_fig};
1319 :    
1320 :     my $cutoff = $args{-cutoff} ? $args{-cutoff} : 1.0e-5;
1321 :     my $all = $args{-all} ? $args{-all} : "fig";
1322 :     my $max = $args{-max} ? $args{-max} : 10000;
1323 :    
1324 :     return $fig->sims($self->id,$max,$cutoff,$all);
1325 :     }
1326 :    
1327 : overbeek 1.4
1328 :    
1329 :     =head3 bbhs
1330 :    
1331 :     =cut
1332 :    
1333 : overbeek 1.2 sub bbhs {
1334 :     my($self) = @_;
1335 :    
1336 :     my $figO = $self->{_figO};
1337 :     my $fig = $figO->{_fig};
1338 :    
1339 :     my @bbhs = $fig->bbhs($self->id);
1340 : overbeek 1.6 return map { my($peg2,$sc,$bs) = @$_; bless({ _figO => $figO,
1341 :     _peg1 => $self->id,
1342 : overbeek 1.2 _peg2 => $peg2,
1343 :     _psc => $sc,
1344 :     _bit_score => $bs
1345 :     },'BBHO') } @bbhs;
1346 :     }
1347 :    
1348 : overbeek 1.4 =head3 display
1349 :    
1350 :     =cut
1351 :    
1352 : overbeek 1.1 sub display {
1353 :     my($self) = @_;
1354 :    
1355 :     print join("\t",$self->id,$self->location,$self->function_of),"\n",
1356 :     $self->dna_seq,"\n",
1357 :     $self->prot_seq,"\n";
1358 :     }
1359 :    
1360 : overbeek 1.4
1361 :    
1362 :     ########################################################################
1363 : overbeek 1.2 package BBHO;
1364 : overbeek 1.4 ########################################################################
1365 :    
1366 :     =head1 BBHO
1367 :    
1368 :     =cut
1369 :    
1370 :    
1371 :     =head3 new
1372 :    
1373 :     =cut
1374 : overbeek 1.2
1375 :     sub new {
1376 : overbeek 1.6 my($class,$figO,$peg1,$peg2,$sc,$normalized_bitscore) = @_;
1377 : overbeek 1.2
1378 :     my $self = {};
1379 : overbeek 1.6 $self->{_figO} = $figO;
1380 : overbeek 1.2 $self->{_peg1} = $peg1;
1381 :     $self->{_peg2} = $peg2;
1382 :     $self->{_psc} = $sc;
1383 :     $self->{_bit_score} = $normalized_bitscore
1384 :    
1385 :     }
1386 :    
1387 : overbeek 1.4
1388 :     =head3 peg1
1389 :    
1390 :     =cut
1391 :    
1392 : overbeek 1.2 sub peg1 {
1393 :     my($self) = @_;
1394 :    
1395 : overbeek 1.6 my $figO = $self->{_figO};
1396 :     return new FeatureO($figO,$self->{_peg1});
1397 : overbeek 1.2 }
1398 :    
1399 : overbeek 1.6 =head3 peg2
1400 : overbeek 1.4
1401 :     =cut
1402 :    
1403 : overbeek 1.2 sub peg2 {
1404 :     my($self) = @_;
1405 :    
1406 : overbeek 1.6 my $figO = $self->{_figO};
1407 :     return new FeatureO($figO,$self->{_peg2});
1408 : overbeek 1.2 }
1409 :    
1410 : overbeek 1.4
1411 :    
1412 :     =head3 psc
1413 :    
1414 :     =cut
1415 :    
1416 : overbeek 1.2 sub psc {
1417 :     my($self) = @_;
1418 :    
1419 :     return $self->{_psc};
1420 :     }
1421 :    
1422 : overbeek 1.4
1423 :    
1424 :     =head3 norm_bitscore
1425 :    
1426 :     =cut
1427 :    
1428 : overbeek 1.2 sub norm_bitscore {
1429 :     my($self) = @_;
1430 :    
1431 :     return $self->{_bit_score};
1432 :     }
1433 :    
1434 : overbeek 1.4
1435 :    
1436 :     ########################################################################
1437 : overbeek 1.1 package AnnotationO;
1438 : overbeek 1.4 ########################################################################
1439 :    
1440 :     =head1 AnnotationO
1441 :    
1442 :     =cut
1443 :    
1444 :    
1445 :    
1446 :     =head3 new
1447 :    
1448 :     =cut
1449 : overbeek 1.1
1450 :     sub new {
1451 :     my($class,$fid,$timestamp,$who,$text) = @_;
1452 :    
1453 :     my $self = {};
1454 :     $self->{_fid} = $fid;
1455 :     $self->{_timestamp} = $timestamp;
1456 :     $self->{_who} = $who;
1457 :     $self->{_text} = $text;
1458 :     return bless $self, $class;
1459 :     }
1460 :    
1461 : overbeek 1.4
1462 :    
1463 :     =head3 fid
1464 :    
1465 :     =cut
1466 :    
1467 : overbeek 1.1 sub fid {
1468 :     my($self) = @_;
1469 :    
1470 :     return $self->{_fid};
1471 :     }
1472 :    
1473 : overbeek 1.4
1474 :    
1475 :     =head3 timestamp
1476 :    
1477 :     =cut
1478 :    
1479 : overbeek 1.1 sub timestamp {
1480 :     my($self,$convert) = @_;
1481 :    
1482 :     if ($convert)
1483 :     {
1484 :     return scalar localtime($self->{_timestamp});
1485 :     }
1486 :     else
1487 :     {
1488 :     return $self->{_timestamp};
1489 :     }
1490 :     }
1491 :    
1492 : overbeek 1.4
1493 :    
1494 :     =head3 made_by
1495 :    
1496 :     =cut
1497 :    
1498 : overbeek 1.1 sub made_by {
1499 :     my($self) = @_;
1500 :    
1501 :     my $who = $self->{_who};
1502 :     $who =~ s/^master://i;
1503 :     return $who;
1504 :     }
1505 :    
1506 : overbeek 1.4
1507 :    
1508 :     =head3 text
1509 :    
1510 :     =cut
1511 :    
1512 : overbeek 1.1 sub text {
1513 :     my($self) = @_;
1514 :    
1515 :     my $text = $self->{_text};
1516 :     return $text;
1517 :     }
1518 :    
1519 : overbeek 1.4
1520 :     =head3 display
1521 :    
1522 :     =cut
1523 :    
1524 : overbeek 1.1 sub display {
1525 :     my($self) = @_;
1526 :    
1527 :     print join("\t",($self->fid,$self->timestamp(1),$self->made_by)),"\n",$self->text,"\n";
1528 :     }
1529 :    
1530 : overbeek 1.4
1531 :    
1532 :     ########################################################################
1533 : overbeek 1.1 package CouplingO;
1534 : overbeek 1.4 ########################################################################
1535 :     use Data::Dumper;
1536 :    
1537 : overbeek 1.13 =head1 CouplingO
1538 :    
1539 :     =cut
1540 :    
1541 :    
1542 :    
1543 : overbeek 1.4 =head3 new
1544 : overbeek 1.1
1545 : overbeek 1.4 =cut
1546 : overbeek 1.1
1547 :     sub new {
1548 :     my($class,$figO,$peg1,$peg2,$sc) = @_;
1549 :    
1550 :     ($peg1 =~ /^fig\|\d+\.\d+\.peg\.\d+$/) || return undef;
1551 :     ($peg2 =~ /^fig\|\d+\.\d+\.peg\.\d+$/) || return undef;
1552 :     my $self = {};
1553 :     $self->{_figO} = $figO;
1554 :     $self->{_peg1} = $peg1;
1555 :     $self->{_peg2} = $peg2;
1556 :     $self->{_sc} = $sc;
1557 :     return bless $self, $class;
1558 :     }
1559 :    
1560 : overbeek 1.4
1561 :    
1562 :     =head3 peg1
1563 :    
1564 :     =cut
1565 :    
1566 : overbeek 1.1 sub peg1 {
1567 :     my($self) = @_;
1568 :    
1569 : overbeek 1.5 my $figO = $self->{_figO};
1570 :     return new FeatureO($figO,$self->{_peg1});
1571 : overbeek 1.1 }
1572 :    
1573 : overbeek 1.4
1574 :    
1575 :     =head3 peg1
1576 :    
1577 :     =cut
1578 :    
1579 : overbeek 1.1 sub peg2 {
1580 :     my($self) = @_;
1581 :    
1582 : overbeek 1.5 my $figO = $self->{_figO};
1583 :     return new FeatureO($figO,$self->{_peg2});
1584 : overbeek 1.1 }
1585 :    
1586 : overbeek 1.4
1587 :    
1588 :     =head3 sc
1589 :    
1590 :     =cut
1591 :    
1592 : overbeek 1.1 sub sc {
1593 :     my($self) = @_;
1594 :    
1595 :     return $self->{_sc};
1596 :     }
1597 :    
1598 : overbeek 1.4
1599 :    
1600 :     =head3 evidence
1601 :    
1602 :     =cut
1603 :    
1604 : overbeek 1.1 sub evidence {
1605 :     my($self) = @_;
1606 :    
1607 :     my $figO = $self->{_figO};
1608 :     my $fig = $figO->{_fig};
1609 :     my @ev = ();
1610 :     foreach my $tuple ($fig->coupling_evidence($self->peg1,$self->peg2))
1611 :     {
1612 :     my($peg3,$peg4,$rep) = @$tuple;
1613 :     push(@ev,[&FeatureO::new('FeatureO',$figO,$peg3),
1614 :     &FeatureO::new('FeatureO',$figO,$peg4),
1615 :     $rep]);
1616 :     }
1617 :     return @ev;
1618 :     }
1619 :    
1620 : overbeek 1.4
1621 :    
1622 :     =head3 display
1623 :    
1624 :     =cut
1625 :    
1626 : overbeek 1.1 sub display {
1627 :     my($self) = @_;
1628 :    
1629 :     print join("\t",($self->peg1,$self->peg2,$self->sc)),"\n";
1630 :     }
1631 :    
1632 : overbeek 1.4
1633 :    
1634 :     ########################################################################
1635 : overbeek 1.1 package SubsystemO;
1636 : overbeek 1.4 ########################################################################
1637 : overbeek 1.1 use Data::Dumper;
1638 :     use Subsystem;
1639 :    
1640 : overbeek 1.4 =head1 SubsystemO
1641 :    
1642 :     =cut
1643 :    
1644 :    
1645 :    
1646 :     =head3 new
1647 :    
1648 :     =cut
1649 :    
1650 : overbeek 1.1 sub new {
1651 :     my($class,$figO,$name) = @_;
1652 :    
1653 :     my $self = {};
1654 :     $self->{_figO} = $figO;
1655 :     $self->{_id} = $name;
1656 :    
1657 :     return bless $self, $class;
1658 :     }
1659 :    
1660 : overbeek 1.4
1661 :    
1662 :     =head3 id
1663 :    
1664 :     =cut
1665 :    
1666 : overbeek 1.1 sub id {
1667 :     my($self) = @_;
1668 :    
1669 :     return $self->{_id};
1670 :     }
1671 :    
1672 : overbeek 1.4
1673 :    
1674 :     =head3 usable
1675 :    
1676 :     =cut
1677 :    
1678 : overbeek 1.1 sub usable {
1679 :     my($self) = @_;
1680 :    
1681 :     my $figO = $self->{_figO};
1682 :     my $fig = $figO->{_fig};
1683 :     return $fig->usable_subsystem($self->id);
1684 :     }
1685 :    
1686 : overbeek 1.4
1687 :    
1688 :     =head3 genomes
1689 :    
1690 :     =cut
1691 :    
1692 : overbeek 1.1 sub genomes {
1693 :     my($self) = @_;
1694 :    
1695 :     my $figO = $self->{_figO};
1696 :     my $subO = $self->{_subO};
1697 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1698 :    
1699 :     return map { &GenomeO::new('GenomeO',$figO,$_) } $subO->get_genomes;
1700 :     }
1701 :    
1702 : overbeek 1.9
1703 :    
1704 : overbeek 1.4 =head3 roles
1705 :    
1706 :     =cut
1707 :    
1708 : overbeek 1.1 sub roles {
1709 :     my($self) = @_;
1710 :    
1711 :     my $figO = $self->{_figO};
1712 :     my $subO = $self->{_subO};
1713 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1714 : overbeek 1.9
1715 : overbeek 1.1 return map { &FunctionalRoleO::new('FunctionalRoleO',$figO,$_) } $subO->get_roles($self->id);
1716 :     }
1717 :    
1718 : overbeek 1.9
1719 :    
1720 : overbeek 1.4 =head3 curator
1721 :    
1722 :     =cut
1723 :    
1724 : overbeek 1.1 sub curator {
1725 :     my($self) = @_;
1726 :    
1727 :     my $figO = $self->{_figO};
1728 :     my $subO = $self->{_subO};
1729 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1730 : overbeek 1.9
1731 :     return $subO->get_curator;
1732 : overbeek 1.1 }
1733 :    
1734 : overbeek 1.4
1735 :    
1736 :    
1737 :     =head3 variant
1738 :    
1739 :     =cut
1740 :    
1741 : overbeek 1.1 sub variant {
1742 :     my($self,$genome) = @_;
1743 :    
1744 :     my $figO = $self->{_figO};
1745 :     my $subO = $self->{_subO};
1746 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1747 :    
1748 :     return $subO->get_variant_code_for_genome($genome->id);
1749 :     }
1750 : overbeek 1.4
1751 :    
1752 :    
1753 :     =head3 pegs_in_cell
1754 :    
1755 :     =cut
1756 :    
1757 : overbeek 1.1 sub pegs_in_cell {
1758 :     my($self,$genome,$role) = @_;
1759 :    
1760 :     my $figO = $self->{_figO};
1761 :     my $subO = $self->{_subO};
1762 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1763 :    
1764 :     return $subO->get_pegs_from_cell($genome->id,$role->id);
1765 :     }
1766 :    
1767 : overbeek 1.4
1768 :    
1769 :     ########################################################################
1770 : overbeek 1.1 package FunctionalRoleO;
1771 : overbeek 1.4 ########################################################################
1772 :     use Data::Dumper;
1773 : overbeek 1.1
1774 : overbeek 1.4 =head1 FunctionalRoleO
1775 :    
1776 : overbeek 1.9 Methods for accessing the functional roles of features.
1777 :    
1778 : overbeek 1.4 =cut
1779 :    
1780 :    
1781 :     =head3 new
1782 :    
1783 :     =cut
1784 : overbeek 1.1
1785 :     sub new {
1786 :     my($class,$figO,$fr) = @_;
1787 :    
1788 :     my $self = {};
1789 :     $self->{_figO} = $figO;
1790 :     $self->{_id} = $fr;
1791 :     return bless $self, $class;
1792 :     }
1793 :    
1794 : overbeek 1.4
1795 :    
1796 :     =head3 id
1797 :    
1798 :     =cut
1799 :    
1800 : overbeek 1.1 sub id {
1801 :     my($self) = @_;
1802 :    
1803 :     return $self->{_id};
1804 :     }
1805 :    
1806 : overbeek 1.4
1807 :    
1808 :     ########################################################################
1809 : overbeek 1.1 package FigFamO;
1810 : overbeek 1.4 ########################################################################
1811 : overbeek 1.1 use FigFams;
1812 :     use FigFam;
1813 :    
1814 : overbeek 1.4
1815 :     =head1 FigFamO
1816 :    
1817 :     =cut
1818 :    
1819 :    
1820 :     =head3 new
1821 :    
1822 :     =cut
1823 :    
1824 : overbeek 1.1 sub new {
1825 :     my($class,$figO,$id) = @_;
1826 :    
1827 :     my $self = {};
1828 :     $self->{_figO} = $figO;
1829 :     $self->{_id} = $id;
1830 :     return bless $self, $class;
1831 :     }
1832 :    
1833 : overbeek 1.4
1834 :    
1835 :     =head3 id
1836 :    
1837 :     =cut
1838 :    
1839 : overbeek 1.1 sub id {
1840 :     my($self) = @_;
1841 :    
1842 :     return $self->{_id};
1843 :     }
1844 :    
1845 : overbeek 1.4
1846 :     =head3 function
1847 :    
1848 :     =cut
1849 :    
1850 : overbeek 1.1 sub function {
1851 :     my($self) = @_;
1852 :    
1853 :     my $fig = $self->{_figO}->{_fig};
1854 :     my $famO = $self->{_famO};
1855 :     if (! $famO) { $famO = $self->{_famO} = &FigFam::new('FigFam',$fig,$self->id) }
1856 :    
1857 :     return $famO->family_function;
1858 :     }
1859 :    
1860 : overbeek 1.4
1861 :    
1862 :     =head3 members
1863 :    
1864 :     =cut
1865 :    
1866 : overbeek 1.1 sub members {
1867 :     my($self) = @_;
1868 :    
1869 :     my $figO = $self->{_figO};
1870 :     my $fig = $figO->{_fig};
1871 :     my $famO = $self->{_famO};
1872 :     if (! $famO) { $famO = $self->{_famO} = &FigFam::new('FigFam',$fig,$self->id) }
1873 :    
1874 :     return map { &FigFamO::new('FigFamO',$figO,$_) } $famO->list_members;
1875 :     }
1876 :    
1877 : overbeek 1.4
1878 :    
1879 :     =head3 rep_seqs
1880 :    
1881 :     =cut
1882 :    
1883 : overbeek 1.1 sub rep_seqs {
1884 :     my($self) = @_;
1885 :    
1886 :     my $figO = $self->{_figO};
1887 :     my $fig = $figO->{_fig};
1888 :     my $famO = $self->{_famO};
1889 :     if (! $famO) { $famO = $self->{_famO} = &FigFam::new('FigFam',$fig,$self->id) }
1890 :    
1891 :     return $famO->representatives;
1892 :     }
1893 :    
1894 : overbeek 1.4
1895 :    
1896 :     =head3 should_be_member
1897 :    
1898 :     =cut
1899 :    
1900 : overbeek 1.1 sub should_be_member {
1901 :     my($self,$seq) = @_;
1902 :    
1903 :     my $figO = $self->{_figO};
1904 :     my $fig = $figO->{_fig};
1905 :     my $famO = $self->{_famO};
1906 :     if (! $famO) { $famO = $self->{_famO} = &FigFam::new('FigFam',$fig,$self->id) }
1907 :    
1908 :     return $famO->should_be_member($seq);
1909 :     }
1910 :    
1911 :    
1912 :    
1913 : overbeek 1.4 =head3 display
1914 :    
1915 :     =cut
1916 :    
1917 : overbeek 1.1 sub display {
1918 :     my($self) = @_;
1919 :    
1920 :     print join("\t",($self->id,$self->function)),"\n";
1921 :     }
1922 :    
1923 :    
1924 :    
1925 : overbeek 1.4 ########################################################################
1926 : overbeek 1.1 package Attribute;
1927 : overbeek 1.4 ########################################################################
1928 :     =head1 Attribute
1929 :    
1930 : overbeek 1.9 (Note yet implemented.)
1931 :    
1932 : overbeek 1.4 =cut
1933 : overbeek 1.1
1934 :     1;
1935 : overbeek 1.4 __END__
1936 :    
1937 :     =head1 Examples
1938 :    
1939 :     =head3 Display all complete, prokaryotic genomes
1940 :    
1941 :     use FIGO;
1942 :     my $figO = new FIGO;
1943 :    
1944 :     foreach $genome ($figO->genomes('complete','prokaryotic'))
1945 :     {
1946 :     $genome->display;
1947 :     }
1948 :    
1949 :     #---------------------------------------------
1950 :    
1951 :     use FIG;
1952 :     my $fig = new FIG;
1953 :    
1954 :     foreach $genome (grep { $fig->is_prokaryotic($_) } $fig->genomes('complete'))
1955 :     {
1956 :     print join("\t",("Genome",$genome,$fig->genus_species($genome))),"\n";
1957 :     }
1958 :    
1959 :     ###############################################
1960 :    
1961 :     =head3 Show how to access contigs and extract sequence
1962 :    
1963 :     use FIGO;
1964 :     my $figO = new FIGO;
1965 :    
1966 :     $genomeId = '83333.1';
1967 :     my $genome = new GenomeO($figO,$genomeId);
1968 :    
1969 :     foreach $contig ($genome->contigs_of)
1970 :     {
1971 :     $tag1 = $contig->dna_seq(1,10);
1972 :     $tag2 = $contig->dna_seq(10,1);
1973 :     print join("\t",($tag1,$tag2,$contig->id,$contig->contig_length)),"\n";
1974 :     }
1975 :    
1976 :     #---------------------------------------------
1977 :    
1978 :     use FIG;
1979 :     my $fig = new FIG;
1980 :    
1981 :     $genomeId = '83333.1';
1982 :    
1983 :     $contig_lengths = $fig->contig_lengths($genomeId);
1984 :    
1985 :     foreach $contig ($fig->contigs_of($genomeId))
1986 :     {
1987 :     $tag1 = $fig->dna_seq($genomeId,join("_",($contig,1,10)));
1988 :     $tag2 = $fig->dna_seq($genomeId,join("_",($contig,10,1)));
1989 :     print join("\t",($tag1,$tag2,$contig,$contig_lengths->{$contig})),"\n";
1990 :     }
1991 :    
1992 :     ###############################################
1993 :    
1994 :     ### accessing data related to features
1995 :    
1996 :     use FIGO;
1997 :     my $figO = new FIGO;
1998 :    
1999 :     my $genome = new GenomeO($figO,"83333.1");
2000 :     my $peg = "fig|83333.1.peg.4";
2001 :     my $pegO = new FeatureO($figO,$peg);
2002 :    
2003 :     print join("\t",$pegO->id,$pegO->location,$pegO->function_of),"\n",
2004 :     $pegO->dna_seq,"\n",
2005 :     $pegO->prot_seq,"\n";
2006 :    
2007 :     foreach $fidO ($genome->features_of('rna'))
2008 :     {
2009 :     print join("\t",$fidO->id,$fidO->location,$fidO->function_of),"\n";
2010 :     }
2011 :    
2012 :     #---------------------------------------------
2013 :    
2014 :    
2015 :     use FIG;
2016 :     my $fig = new FIG;
2017 :    
2018 :     my $genome = "83333.1";
2019 :     my $peg = "fig|83333.1.peg.4";
2020 :    
2021 :     print join("\t",$peg,scalar $fig->feature_location($peg),scalar $fig->function_of($peg)),"\n",
2022 :     $fig->dna_seq($genome,$fig->feature_location($peg)),"\n",
2023 :     $fig->get_translation($peg),"\n";
2024 :    
2025 :     foreach $fid ($fig->all_features($genome,'rna'))
2026 :     {
2027 :     print join("\t",$fid,scalar $fig->feature_location($fid),scalar $fig->function_of($fid)),"\n";
2028 :     }
2029 :    
2030 :     ###############################################
2031 :    
2032 :     ### accessing similarities
2033 :    
2034 :     use FIGO;
2035 :     my $figO = new FIGO;
2036 :    
2037 :     $peg = "fig|83333.1.peg.4";
2038 :     $pegO = new FeatureO($figO,$peg);
2039 :    
2040 :     @sims = $pegO->sims; # use sims( -all => 1, -max => 10000, -cutoff => 1.0e-20) to all
2041 :     # sims (including non-FIG sequences
2042 :     foreach $sim (@sims)
2043 :     {
2044 :     $peg2 = $sim->id2;
2045 :     $pegO2 = new FeatureO($figO,$peg2);
2046 :     $func = $pegO2->function_of;
2047 :     $sc = $sim->psc;
2048 :     print join("\t",($peg2,$sc,$func)),"\n";
2049 :     }
2050 :    
2051 :     #---------------------------------------------
2052 :    
2053 :    
2054 :     use FIG;
2055 :     my $fig = new FIG;
2056 :    
2057 :     $peg = "fig|83333.1.peg.4";
2058 :    
2059 :     @sims = $fig->sims($peg,1000,1.0e-5,"fig");
2060 :     foreach $sim (@sims)
2061 :     {
2062 :     $peg2 = $sim->id2;
2063 :     $func = $fig->function_of($peg2);
2064 :     $sc = $sim->psc;
2065 :     print join("\t",($peg2,$sc,$func)),"\n";
2066 :     }
2067 :    
2068 :     ###############################################
2069 :    
2070 :     ### accessing BBHs
2071 :    
2072 :     use FIGO;
2073 :     my $figO = new FIGO;
2074 :    
2075 :     $peg = "fig|83333.1.peg.4";
2076 :     $pegO = new FeatureO($figO,$peg);
2077 :    
2078 :     @bbhs = $pegO->bbhs;
2079 :     foreach $bbh (@bbhs)
2080 :     {
2081 :     $peg2 = $bbh->peg2;
2082 :     $pegO2 = new FeatureO($figO,$peg2);
2083 :     $func = $pegO2->function_of;
2084 :     $sc = $bbh->psc;
2085 :     print join("\t",($peg2,$sc,$func)),"\n";
2086 :     }
2087 :    
2088 :     #---------------------------------------------
2089 :    
2090 :     use FIG;
2091 :     my $fig = new FIG;
2092 :    
2093 :     $peg = "fig|83333.1.peg.4";
2094 :    
2095 :     @bbhs = $fig->bbhs($peg);
2096 :     foreach $bbh (@bbhs)
2097 :     {
2098 :     ($peg2,$sc,$bit_score) = @$bbh;
2099 :     $func = $fig->function_of($peg2);
2100 :     print join("\t",($peg2,$sc,$func)),"\n";
2101 :     }
2102 :    
2103 :     ###############################################
2104 :    
2105 :     ### accessing annotations
2106 :    
2107 :     use FIGO;
2108 :     my $figO = new FIGO;
2109 :    
2110 :     $peg = "fig|83333.1.peg.4";
2111 :     $pegO = new FeatureO($figO,$peg);
2112 :    
2113 :     @annotations = $pegO->annotations;
2114 :    
2115 :     foreach $ann (@annotations)
2116 :     {
2117 :     print join("\n",$ann->fid,$ann->timestamp(1),$ann->made_by,$ann->text),"\n\n";
2118 :     }
2119 :    
2120 :     #---------------------------------------------
2121 :    
2122 :     use FIG;
2123 :     my $fig = new FIG;
2124 :    
2125 :     $peg = "fig|83333.1.peg.4";
2126 :     @annotations = $fig->feature_annotations($peg);
2127 :     foreach $_ (@annotations)
2128 :     {
2129 :     (undef,$ts,$who,$text) = @$_;
2130 :     $who =~ s/master://i;
2131 :     print "$ts\n$who\n$text\n\n";
2132 :     }
2133 :    
2134 :     ###############################################
2135 :    
2136 :     ### accessing coupling data
2137 :    
2138 :    
2139 :     use FIGO;
2140 :     my $figO = new FIGO;
2141 :    
2142 :     my $peg = "fig|83333.1.peg.4";
2143 :     my $pegO = new FeatureO($figO,$peg);
2144 :     foreach $coupled ($pegO->coupled_to)
2145 :     {
2146 :     print join("\t",($coupled->peg1,$coupled->peg2,$coupled->sc)),"\n";
2147 :     foreach $tuple ($coupled->evidence)
2148 :     {
2149 :     my($peg3O,$peg4O,$rep) = @$tuple;
2150 :     print "\t",join("\t",($peg3O->id,$peg4O->id,$rep)),"\n";
2151 :     }
2152 :     print "\n";
2153 :     }
2154 :    
2155 :     #---------------------------------------------
2156 :    
2157 :    
2158 :     use FIG;
2159 :     my $fig = new FIG;
2160 :    
2161 :     my $peg1 = "fig|83333.1.peg.4";
2162 :     foreach $coupled ($fig->coupled_to($peg1))
2163 :     {
2164 :     ($peg2,$sc) = @$coupled;
2165 :     print join("\t",($peg1,$peg2,$sc)),"\n";
2166 :     foreach $tuple ($fig->coupling_evidence($peg1,$peg2))
2167 :     {
2168 :     my($peg3,$peg4,$rep) = @$tuple;
2169 :     print "\t",join("\t",($peg3,$peg4,$rep)),"\n";
2170 :     }
2171 :     print "\n";
2172 :     }
2173 :    
2174 :     ###############################################
2175 :    
2176 :     =head3 Accessing Subsystem data
2177 :    
2178 :     use FIGO;
2179 :     my $figO = new FIGO;
2180 :    
2181 :     foreach $sub ($figO->subsystems)
2182 :     {
2183 :     if ($sub->usable)
2184 :     {
2185 :     print join("\t",($sub->id,$sub->curator)),"\n";
2186 :    
2187 :     print "\tRoles\n";
2188 :     @roles = $sub->roles;
2189 :     foreach $role (@roles)
2190 :     {
2191 :     print "\t\t",join("\t",($role->id)),"\n";
2192 :     }
2193 :    
2194 :     print "\tGenomes\n";
2195 :     foreach $genome ($sub->genomes)
2196 :     {
2197 :     print "\t\t",join("\t",($sub->variant($genome),
2198 :     $genome->id,
2199 :     $genome->genus_species)),"\n";
2200 :     @pegs = ();
2201 :     foreach $role (@roles)
2202 :     {
2203 :     push(@pegs,$sub->pegs_in_cell($genome,$role));
2204 :     }
2205 :     print "\t\t\t",join(",",@pegs),"\n";
2206 :     }
2207 :     }
2208 :     }
2209 :    
2210 :     #---------------------------------------------
2211 :    
2212 :     use FIG;
2213 :     my $fig = new FIG;
2214 :    
2215 :     foreach $sub (grep { $fig->usable_subsystem($_) } $fig->all_subsystems)
2216 :     {
2217 :     $subO = new Subsystem($sub,$fig);
2218 :     $curator = $subO->get_curator;
2219 :     print join("\t",($sub,$curator)),"\n";
2220 :    
2221 :     print "\tRoles\n";
2222 :     @roles = $subO->get_roles;
2223 :     foreach $role (@roles)
2224 :     {
2225 :     print "\t\t",join("\t",($role)),"\n";
2226 :     }
2227 :    
2228 :     print "\tGenomes\n";
2229 :     foreach $genome ($subO->get_genomes)
2230 :     {
2231 :     print "\t\t",join("\t",($subO->get_variant_code_for_genome($genome),
2232 :     $genome,
2233 :     $fig->genus_species($genome))),"\n";
2234 :     foreach $role (@roles)
2235 :     {
2236 :     push(@pegs,$subO->get_pegs_from_cell($genome,$role));
2237 :     }
2238 :     print "\t\t\t",join(",",@pegs),"\n";
2239 :     }
2240 :     print "\n";
2241 :     }
2242 :    
2243 :     ###############################################
2244 :    
2245 :     =head3 Accessing FIGfams
2246 :    
2247 :     use FIGO;
2248 :     my $figO = new FIGO;
2249 :    
2250 :     foreach $fam ($figO->all_figfams)
2251 :     {
2252 :     print join("\t",($fam->id,$fam->function)),"\n";
2253 :     foreach $pegO ($fam->members)
2254 :     {
2255 :     $peg = $pegO->id;
2256 :     print "\t$peg\n";
2257 :     }
2258 :     }
2259 :    
2260 :     #---------------------------------------------
2261 :    
2262 :     use FIG;
2263 :     use FigFam;
2264 :     use FigFams;
2265 :    
2266 :     my $fig = new FIG;
2267 :     my $figfams = new FigFams($fig);
2268 :    
2269 :     foreach $fam ($figfams->all_families)
2270 :     {
2271 :     my $figfam = new FigFam($fig,$fam);
2272 :     print join("\t",($fam,$figfam->family_function)),"\n";
2273 :     foreach $peg ($figfam->list_members)
2274 :     {
2275 :     print "\t$peg\n";
2276 :     }
2277 :     }
2278 :    
2279 :     ###############################################
2280 :    
2281 :     =head3 Placing a sequence into a FIGfam
2282 :    
2283 :     use FIGO;
2284 :     my $figO = new FIGO;
2285 :    
2286 :     $seq = "MKLYNLKDHNEQVSFAQAVTQGLGKNQGLFFPHDLPEFSLTEIDEMLKLDFVTRSAKILS
2287 :     AFIGDEIPQEILEERVRAAFAFPAPVANVESDVGCLELFHGPTLAFKDFGGRFMAQMLTH
2288 :     IAGDKPVTILTATSGDTGAAVAHAFYGLPNVKVVILYPRGKISPLQEKLFCTLGGNIETV
2289 :     AIDGDFDACQALVKQAFDDEELKVALGLNSANSINISRLLAQICYYFEAVAQLPQETRNQ
2290 :     LVVSVPSGNFGDLTAGLLAKSLGLPVKRFIAATNVNDTVPRFLHDGQWSPKATQATLSNA
2291 :     MDVSQPNNWPRVEELFRRKIWQLKELGYAAVDDETTQQTMRELKELGYTSEPHAAVAYRA
2292 :     LRDQLNPGEYGLFLGTAHPAKFKESVEAILGETLDLPKELAERADLPLLSHNLPADFAAL
2293 :     RKLMMNHQ";
2294 :     $seq =~ s/\n//gs;
2295 :    
2296 :     my($fam,$sims) = $figO->family_containing($seq);
2297 :    
2298 :     if ($fam)
2299 :     {
2300 :     print join("\t",($fam->id,$fam->function)),"\n";
2301 :     print &Dumper($sims);
2302 :     }
2303 :     else
2304 :     {
2305 :     print "Could not place it in a family\n";
2306 :     }
2307 :    
2308 :     #---------------------------------------------
2309 :    
2310 :     use FIG;
2311 :     use FigFam;
2312 :     use FigFams;
2313 :    
2314 :     my $fig = new FIG;
2315 :     my $figfams = new FigFams($fig);
2316 :    
2317 :     $seq = "MKLYNLKDHNEQVSFAQAVTQGLGKNQGLFFPHDLPEFSLTEIDEMLKLDFVTRSAKILS
2318 :     AFIGDEIPQEILEERVRAAFAFPAPVANVESDVGCLELFHGPTLAFKDFGGRFMAQMLTH
2319 :     IAGDKPVTILTATSGDTGAAVAHAFYGLPNVKVVILYPRGKISPLQEKLFCTLGGNIETV
2320 :     AIDGDFDACQALVKQAFDDEELKVALGLNSANSINISRLLAQICYYFEAVAQLPQETRNQ
2321 :     LVVSVPSGNFGDLTAGLLAKSLGLPVKRFIAATNVNDTVPRFLHDGQWSPKATQATLSNA
2322 :     MDVSQPNNWPRVEELFRRKIWQLKELGYAAVDDETTQQTMRELKELGYTSEPHAAVAYRA
2323 :     LRDQLNPGEYGLFLGTAHPAKFKESVEAILGETLDLPKELAERADLPLLSHNLPADFAAL
2324 :     RKLMMNHQ";
2325 :     $seq =~ s/\n//gs;
2326 :    
2327 :     my($fam,$sims) = $figfams->place_in_family($seq);
2328 :    
2329 :     if ($fam)
2330 :     {
2331 :     print join("\t",($fam->family_id,$fam->family_function)),"\n";
2332 :     print &Dumper($sims);
2333 :     }
2334 :     else
2335 :     {
2336 :     print "Could not place it in a family\n";
2337 :     }
2338 :    
2339 :     ###############################################
2340 :    
2341 :     =head3 Getting representative sequences for a FIGfam
2342 :    
2343 :     use FIGO;
2344 :     my $figO = new FIGO;
2345 :    
2346 :     $fam = "FIG102446";
2347 :     my $famO = &FigFamO::new('FigFamO',$figO,$fam);
2348 :     my @rep_seqs = $famO->rep_seqs;
2349 :    
2350 :     foreach $seq (@rep_seqs)
2351 :     {
2352 :     print ">query\n$seq\n";
2353 :     }
2354 :    
2355 :     #---------------------------------------------
2356 :    
2357 :     use FIG;
2358 :     use FigFam;
2359 :     use FigFams;
2360 :    
2361 :     my $fig = new FIG;
2362 :    
2363 :     $fam = "FIG102446";
2364 :     my $famO = new FigFam($fig,$fam);
2365 :     my @rep_seqs = $famO->representatives;
2366 :    
2367 :     foreach $seq (@rep_seqs)
2368 :     {
2369 :     print ">query\n$seq\n";
2370 :     }
2371 :    
2372 :    
2373 :     ###############################################
2374 :    
2375 :    
2376 :     =head3 Testing for membership in FIGfam
2377 :    
2378 :     use FIGO;
2379 :     my $figO = new FIGO;
2380 :    
2381 :     $seq = "MKLYNLKDHNEQVSFAQAVTQGLGKNQGLFFPHDLPEFSLTEIDEMLKLDFVTRSAKILS
2382 :     AFIGDEIPQEILEERVRAAFAFPAPVANVESDVGCLELFHGPTLAFKDFGGRFMAQMLTH
2383 :     IAGDKPVTILTATSGDTGAAVAHAFYGLPNVKVVILYPRGKISPLQEKLFCTLGGNIETV
2384 :     AIDGDFDACQALVKQAFDDEELKVALGLNSANSINISRLLAQICYYFEAVAQLPQETRNQ
2385 :     LVVSVPSGNFGDLTAGLLAKSLGLPVKRFIAATNVNDTVPRFLHDGQWSPKATQATLSNA
2386 :     MDVSQPNNWPRVEELFRRKIWQLKELGYAAVDDETTQQTMRELKELGYTSEPHAAVAYRA
2387 :     LRDQLNPGEYGLFLGTAHPAKFKESVEAILGETLDLPKELAERADLPLLSHNLPADFAAL
2388 :     RKLMMNHQ";
2389 :     $seq =~ s/\n//gs;
2390 :    
2391 :     $fam = "FIG102446";
2392 :     my $famO = &FigFamO::new('FigFamO',$figO,$fam);
2393 :     my($should_be, $sims) = $famO->should_be_member($seq);
2394 :    
2395 :     if ($should_be)
2396 :     {
2397 :     print join("\t",($famO->id,$famO->function)),"\n";
2398 :     print &Dumper($sims);
2399 :     }
2400 :     else
2401 :     {
2402 :     print "Sequence should not be added to family\n";
2403 :     }
2404 :    
2405 :     #---------------------------------------------
2406 :    
2407 :     use FIG;
2408 :     use FigFam;
2409 :     use FigFams;
2410 :    
2411 :     my $fig = new FIG;
2412 :    
2413 :     $seq = "MKLYNLKDHNEQVSFAQAVTQGLGKNQGLFFPHDLPEFSLTEIDEMLKLDFVTRSAKILS
2414 :     AFIGDEIPQEILEERVRAAFAFPAPVANVESDVGCLELFHGPTLAFKDFGGRFMAQMLTH
2415 :     IAGDKPVTILTATSGDTGAAVAHAFYGLPNVKVVILYPRGKISPLQEKLFCTLGGNIETV
2416 :     AIDGDFDACQALVKQAFDDEELKVALGLNSANSINISRLLAQICYYFEAVAQLPQETRNQ
2417 :     LVVSVPSGNFGDLTAGLLAKSLGLPVKRFIAATNVNDTVPRFLHDGQWSPKATQATLSNA
2418 :     MDVSQPNNWPRVEELFRRKIWQLKELGYAAVDDETTQQTMRELKELGYTSEPHAAVAYRA
2419 :     LRDQLNPGEYGLFLGTAHPAKFKESVEAILGETLDLPKELAERADLPLLSHNLPADFAAL
2420 :     RKLMMNHQ";
2421 :     $seq =~ s/\n//gs;
2422 :    
2423 :     $fam = "FIG102446";
2424 :     my $famO = new FigFam($fig,$fam);
2425 :     my($should_be, $sims) = $famO->should_be_member($seq);
2426 :    
2427 :     if ($should_be)
2428 :     {
2429 :     print join("\t",($famO->family_id,$famO->family_function)),"\n";
2430 :     print &Dumper($sims);
2431 :     }
2432 :     else
2433 :     {
2434 :     print "Sequence should not be added to family\n";
2435 :     }
2436 :    
2437 :     =cut
2438 :    

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3