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

Annotation of /FigKernelPackages/FIGO.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3