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

Annotation of /FigKernelPackages/FIGO.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3