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

Annotation of /FigKernelPackages/FIGO.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3