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

Annotation of /FigKernelPackages/FIGO.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.10 - (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 : overbeek 1.10 my $figO = $self->{_figO};
559 :     return new GenomeO($figO,$self->{_genome});
560 : overbeek 1.1 }
561 :    
562 : overbeek 1.4
563 :    
564 :     =head3 contig_length
565 :    
566 : overbeek 1.9 =over 4
567 : overbeek 1.4
568 :     =item USAGE:
569 : overbeek 1.9
570 : overbeek 1.4 C<< my $len = $contig->contig_length(); >>
571 :    
572 : overbeek 1.9 =item RETURNS:
573 :    
574 :     Length of contig's DNA sequence.
575 : overbeek 1.4
576 :     =back
577 :    
578 :     =cut
579 :    
580 : overbeek 1.1 sub contig_length {
581 :     my($self) = @_;
582 :    
583 :     my $fig = $self->{_figO}->{_fig};
584 :     my $contig_lengths = $fig->contig_lengths($self->genome);
585 :     return $contig_lengths->{$self->id};
586 :     }
587 :    
588 : overbeek 1.4
589 :     =head3 dna_seq
590 :    
591 : overbeek 1.9 =over 4
592 : overbeek 1.4
593 :     =item USAGE:
594 : overbeek 1.9
595 : overbeek 1.4 C<< my $seq = $contig->dna_seq(beg, $end); >>
596 :    
597 : overbeek 1.9 =item $beg:
598 :    
599 :     Begining point of DNA subsequence
600 : overbeek 1.4
601 : overbeek 1.9 =item $end:
602 : overbeek 1.4
603 : overbeek 1.9 End point of DNA subsequence
604 : overbeek 1.4
605 : overbeek 1.9 =item RETURNS:
606 :    
607 :     string of DNA sequence running from $beg to $end
608 :     (NOTE: if $beg > $end, returns reverse complement of DNA subsequence.)
609 : overbeek 1.4
610 :     =back
611 :    
612 :     =cut
613 :    
614 : overbeek 1.1 sub dna_seq {
615 :     my($self,$beg,$end) = @_;
616 :    
617 :     my $fig = $self->{_figO}->{_fig};
618 :     my $max = $self->contig_length;
619 :     if (($beg && (&FIG::between(1,$beg,$max))) &&
620 :     ($end && (&FIG::between(1,$end,$max))))
621 :     {
622 :     return $fig->dna_seq($self->genome,join("_",($self->id,$beg,$end)));
623 :     }
624 :     else
625 :     {
626 :     return undef;
627 :     }
628 :     }
629 :    
630 : overbeek 1.4
631 :     =head3 display
632 :    
633 :     Prints summary information about a "ContigO" object to STDOUT:
634 :    
635 :     Genus, species, strain
636 :    
637 :     Contig ID
638 :    
639 :     Contig length
640 :    
641 : overbeek 1.9 =over 4
642 :    
643 :     =item RETURNS:
644 : overbeek 1.4
645 : overbeek 1.9 (Void)
646 : overbeek 1.4
647 :     =back
648 :    
649 :     =cut
650 :    
651 : overbeek 1.1 sub display {
652 :     my($self) = @_;
653 :    
654 :     print join("ContigO",$self->genome,$self->id,$self->contig_length),"\n";
655 :     }
656 :    
657 : overbeek 1.10 sub features_in_region {
658 :     my($self,$beg,$end) = @_;
659 :     my $figO = $self->{_figO};
660 :     my $fig = $figO->{_fig};
661 : overbeek 1.4
662 : overbeek 1.10 my($features) = $fig->genes_in_region($self->genome->id,$self->id,$beg,$end);
663 :     return map { new FeatureO($figO,$_) } @$features;
664 :     }
665 : overbeek 1.4
666 :     ########################################################################
667 : overbeek 1.1 package FeatureO;
668 : overbeek 1.4 ########################################################################
669 :     use Data::Dumper;
670 :    
671 :     =head1 FeatureO
672 :    
673 : overbeek 1.9 Methods for working with features on "ContigO" objects.
674 :    
675 : overbeek 1.4 =cut
676 :    
677 : overbeek 1.9 =head3 new
678 : overbeek 1.4
679 :     Constructor of "FeatureO" objects
680 :    
681 :     =cut
682 : overbeek 1.1
683 :     sub new {
684 :     my($class,$figO,$fid) = @_;
685 :    
686 :     ($fid =~ /^fig\|\d+\.\d+\.[^\.]+\.\d+$/) || return undef;
687 :     my $self = {};
688 :     $self->{_figO} = $figO;
689 :     $self->{_id} = $fid;
690 :     return bless $self, $class;
691 :     }
692 :    
693 : overbeek 1.4
694 :     =head3 id
695 :    
696 :     =cut
697 :    
698 : overbeek 1.1 sub id {
699 :     my($self) = @_;
700 :    
701 :     return $self->{_id};
702 :     }
703 :    
704 : overbeek 1.4
705 :    
706 :     =head3 genome
707 :    
708 :     =cut
709 :    
710 : overbeek 1.1 sub genome {
711 :     my($self) = @_;
712 :    
713 :     $self->id =~ /^fig\|(\d+\.\d+)/;
714 :     return $1;
715 :     }
716 :    
717 : overbeek 1.4
718 :    
719 :     =head3 type
720 :    
721 :     =cut
722 :    
723 : overbeek 1.1 sub type {
724 :     my($self) = @_;
725 :    
726 :     $self->id =~ /^fig\|\d+\.\d+\.([^\.]+)/;
727 :     return $1;
728 :     }
729 :    
730 : overbeek 1.4
731 :    
732 :    
733 :     =head3 location
734 :    
735 :     =cut
736 :    
737 : overbeek 1.1 sub location {
738 :     my($self) = @_;
739 :    
740 :     my $fig = $self->{_figO}->{_fig};
741 :     return scalar $fig->feature_location($self->id);
742 :     }
743 :    
744 : overbeek 1.4
745 :    
746 :     =head3 dna_seq
747 :    
748 :     =cut
749 :    
750 : overbeek 1.1 sub dna_seq {
751 :     my($self) = @_;
752 :    
753 :     my $fig = $self->{_figO}->{_fig};
754 :     my $fid = $self->id;
755 :     my @loc = $fig->feature_location($fid);
756 :     return $fig->dna_seq(&FIG::genome_of($fid),@loc);
757 :     }
758 :    
759 : overbeek 1.4
760 :    
761 :     =head3 prot_seq
762 :    
763 :     =cut
764 :    
765 : overbeek 1.1 sub prot_seq {
766 :     my($self) = @_;
767 :    
768 :     ($self->type eq "peg") || return undef;
769 :     my $fig = $self->{_figO}->{_fig};
770 :     my $fid = $self->id;
771 :     return $fig->get_translation($fid);
772 :     }
773 :    
774 : overbeek 1.4
775 :    
776 :     =head3 function_of
777 :    
778 :     =cut
779 :    
780 : overbeek 1.1 sub function_of {
781 :     my($self) = @_;
782 :    
783 :     my $fig = $self->{_figO}->{_fig};
784 :     my $fid = $self->id;
785 :     return scalar $fig->function_of($fid);
786 :     }
787 :    
788 : overbeek 1.4
789 :    
790 :     =head3 coupled_to
791 :    
792 :     =cut
793 :    
794 : overbeek 1.1 sub coupled_to {
795 :     my($self) = @_;
796 :    
797 :     ($self->type eq "peg") || return undef;
798 :     my $figO = $self->{_figO};
799 :     my $fig = $figO->{_fig};
800 :     my $peg1 = $self->id;
801 :     my @coupled = ();
802 :     foreach my $tuple ($fig->coupled_to($peg1))
803 :     {
804 :     my($peg2,$sc) = @$tuple;
805 :     push(@coupled, &CouplingO::new('CouplingO',$figO,$peg1,$peg2,$sc));
806 :     }
807 :     return @coupled;
808 :     }
809 :    
810 : overbeek 1.4
811 :    
812 :     =head3 annotations
813 :    
814 :     =cut
815 :    
816 : overbeek 1.1 sub annotations {
817 :     my($self) = @_;
818 :    
819 :     my $figO = $self->{_figO};
820 :     my $fig = $figO->{_fig};
821 :    
822 :     return map { &AnnotationO::new('AnnotationO',@$_) } $fig->feature_annotations($self->id,1);
823 :     }
824 :    
825 : overbeek 1.5 sub in_subsystems {
826 :     my($self) = @_;
827 :     my $figO = $self->{_figO};
828 :     my $fig = $figO->{_fig};
829 :    
830 :     return map { new SubsystemO($figO,$_) } $fig->peg_to_subsystems($self->id);
831 :     }
832 : overbeek 1.4
833 :    
834 :     =head3 possibly_truncated
835 :    
836 :     =cut
837 :    
838 : overbeek 1.3 sub possibly_truncated {
839 :     my($self) = @_;
840 :     my $figO = $self->{_figO};
841 :     my $fig = $figO->{_fig};
842 :    
843 :     return $fig->possibly_truncated($self->id);
844 :     }
845 :    
846 : overbeek 1.4
847 :    
848 :     =head3 possible_frameshift
849 :    
850 :     =cut
851 :    
852 : overbeek 1.3 sub possible_frameshift {
853 :     my($self) = @_;
854 :     my $figO = $self->{_figO};
855 :     my($tmp_dir) = $figO->{_tmp_dir};
856 :    
857 :     if (! $self->possibly_truncated)
858 :     {
859 :     my @sims = $self->sims( -max => 1, -cutoff => 1.0e-50);
860 :     if (my $sim = shift @sims)
861 :     {
862 :     my $peg2 = $sim->id2;
863 :     my $ln1 = $sim->ln1;
864 :     my $ln2 = $sim->ln2;
865 :     my $b2 = $sim->b2;
866 :     my $e2 = $sim->e2;
867 :     my $adjL = 100 + (($b2-1) * 3);
868 :     my $adjR = 100 + (($ln2 - $e2) * 3);
869 :     if ($ln2 > (1.2 * $ln1))
870 :     {
871 :     my $loc = $self->location;
872 :     if ($loc =~ /^(\S+)_(\d+)_(\d+)/)
873 :     {
874 :     my $contig = $1;
875 :     my $beg = $2;
876 :     my $end = $3;
877 :     my $contigO = new ContigO($figO,$self->genome,$contig);
878 :     my $begA = &max(1,$beg - $adjL);
879 :     my $endA = &min($end+$adjR,$contigO->contig_length);
880 :     my $dna = $contigO->dna_seq($begA,$endA);
881 :     open(TMP,">$tmp_dir/tmp_dna") || die "couild not open tmp_dna";
882 :     print TMP ">dna\n$dna\n";
883 :     close(TMP);
884 :    
885 :     my $peg2O = new FeatureO($figO,$peg2);
886 :     my $prot = $peg2O->prot_seq;
887 :     open(TMP,">$tmp_dir/tmp_prot") || die "could not open tmp_prot";
888 :     print TMP ">tmp_prot\n$prot\n";
889 :     close(TMP);
890 :     &run("formatdb -i $tmp_dir/tmp_dna -pF");
891 :     open(BLAST,"blastall -i $tmp_dir/tmp_prot -d $tmp_dir/tmp_dna -p tblastn -FF -e 1.0e-50 |")
892 :     || die "could not blast";
893 :    
894 :     my $db_seq_out = &gjoparseblast::next_blast_subject(\*BLAST,1);
895 :     my @hsps = sort { $a->[0] <=> $b->[0] }
896 :     map { [$_->[9],$_->[10],$_->[12],$_->[13]] }
897 :     grep { $_->[1] < 1.0e-50 }
898 :     @{$db_seq_out->[6]};
899 :     my @prot = map { [$_->[0],$_->[1]] } @hsps;
900 :     my @dna = map { [$_->[2],$_->[3]] } @hsps;
901 :     if (&covers(\@prot,length($prot),3) && &covers(\@dna,3*length($prot),9))
902 :     {
903 :     return 1;
904 :     }
905 :     }
906 :     }
907 :     }
908 :     }
909 :     return 0;
910 :     }
911 :    
912 : overbeek 1.4
913 :    
914 :     =head3 run
915 :    
916 : overbeek 1.9 =sub
917 : overbeek 1.4
918 : overbeek 1.9 cut run {
919 : overbeek 1.3 my($cmd) = @_;
920 :     (system($cmd) == 0) || Confess("FAILED: $cmd");
921 :     }
922 :    
923 : overbeek 1.4
924 :    
925 :     =head3 max
926 :    
927 :     =cut
928 :    
929 : overbeek 1.3 sub max {
930 :     my($x,$y) = @_;
931 :     return ($x < $y) ? $y : $x;
932 :     }
933 :    
934 : overbeek 1.4
935 :    
936 :     =head3 min
937 :    
938 :     =cut
939 :    
940 : overbeek 1.3 sub min {
941 :     my($x,$y) = @_;
942 :     return ($x < $y) ? $x : $y;
943 :     }
944 :    
945 : overbeek 1.4
946 :    
947 :     =head3 covers
948 :    
949 :     =cut
950 :    
951 : overbeek 1.3 sub covers {
952 :     my($hsps,$ln,$diff) = @_;
953 :    
954 :     my $hsp1 = shift @$hsps;
955 :     my $hsp2;
956 :     while ($hsp1 && ($hsp2 = shift @$hsps) && ($hsp1 = &merge($hsp1,$hsp2,$diff))) {}
957 :     return ($hsp1 && (($hsp1->[1] - $hsp1->[0]) > (0.9 * $ln)));
958 :     }
959 :    
960 : overbeek 1.4
961 :    
962 :     =head3 merge
963 :    
964 :     =cut
965 :    
966 : overbeek 1.3 sub merge {
967 :     my($hsp1,$hsp2,$diff) = @_;
968 :    
969 :     my($b1,$e1) = @$hsp1;
970 :     my($b2,$e2) = @$hsp2;
971 :     return (($e2 > $e1) && (abs($b2-$e1) <= $diff)) ? [$b1,$e2] : undef;
972 :     }
973 :    
974 : overbeek 1.4
975 :    
976 :     =head3 sims
977 :    
978 :     =cut
979 :    
980 : overbeek 1.2 use Sim;
981 :     sub sims {
982 :     my($self,%args) = @_;
983 :    
984 :     my $figO = $self->{_figO};
985 :     my $fig = $figO->{_fig};
986 :    
987 :     my $cutoff = $args{-cutoff} ? $args{-cutoff} : 1.0e-5;
988 :     my $all = $args{-all} ? $args{-all} : "fig";
989 :     my $max = $args{-max} ? $args{-max} : 10000;
990 :    
991 :     return $fig->sims($self->id,$max,$cutoff,$all);
992 :     }
993 :    
994 : overbeek 1.4
995 :    
996 :     =head3 bbhs
997 :    
998 :     =cut
999 :    
1000 : overbeek 1.2 sub bbhs {
1001 :     my($self) = @_;
1002 :    
1003 :     my $figO = $self->{_figO};
1004 :     my $fig = $figO->{_fig};
1005 :    
1006 :     my @bbhs = $fig->bbhs($self->id);
1007 : overbeek 1.6 return map { my($peg2,$sc,$bs) = @$_; bless({ _figO => $figO,
1008 :     _peg1 => $self->id,
1009 : overbeek 1.2 _peg2 => $peg2,
1010 :     _psc => $sc,
1011 :     _bit_score => $bs
1012 :     },'BBHO') } @bbhs;
1013 :     }
1014 :    
1015 : overbeek 1.4 =head3 display
1016 :    
1017 :     =cut
1018 :    
1019 : overbeek 1.1 sub display {
1020 :     my($self) = @_;
1021 :    
1022 :     print join("\t",$self->id,$self->location,$self->function_of),"\n",
1023 :     $self->dna_seq,"\n",
1024 :     $self->prot_seq,"\n";
1025 :     }
1026 :    
1027 : overbeek 1.4
1028 :    
1029 :     ########################################################################
1030 : overbeek 1.2 package BBHO;
1031 : overbeek 1.4 ########################################################################
1032 :    
1033 :     =head1 BBHO
1034 :    
1035 :     =cut
1036 :    
1037 :    
1038 :     =head3 new
1039 :    
1040 :     =cut
1041 : overbeek 1.2
1042 :     sub new {
1043 : overbeek 1.6 my($class,$figO,$peg1,$peg2,$sc,$normalized_bitscore) = @_;
1044 : overbeek 1.2
1045 :     my $self = {};
1046 : overbeek 1.6 $self->{_figO} = $figO;
1047 : overbeek 1.2 $self->{_peg1} = $peg1;
1048 :     $self->{_peg2} = $peg2;
1049 :     $self->{_psc} = $sc;
1050 :     $self->{_bit_score} = $normalized_bitscore
1051 :    
1052 :     }
1053 :    
1054 : overbeek 1.4
1055 :     =head3 peg1
1056 :    
1057 :     =cut
1058 :    
1059 : overbeek 1.2 sub peg1 {
1060 :     my($self) = @_;
1061 :    
1062 : overbeek 1.6 my $figO = $self->{_figO};
1063 :     return new FeatureO($figO,$self->{_peg1});
1064 : overbeek 1.2 }
1065 :    
1066 : overbeek 1.6 =head3 peg2
1067 : overbeek 1.4
1068 :     =cut
1069 :    
1070 : overbeek 1.2 sub peg2 {
1071 :     my($self) = @_;
1072 :    
1073 : overbeek 1.6 my $figO = $self->{_figO};
1074 :     return new FeatureO($figO,$self->{_peg2});
1075 : overbeek 1.2 }
1076 :    
1077 : overbeek 1.4
1078 :    
1079 :     =head3 psc
1080 :    
1081 :     =cut
1082 :    
1083 : overbeek 1.2 sub psc {
1084 :     my($self) = @_;
1085 :    
1086 :     return $self->{_psc};
1087 :     }
1088 :    
1089 : overbeek 1.4
1090 :    
1091 :     =head3 norm_bitscore
1092 :    
1093 :     =cut
1094 :    
1095 : overbeek 1.2 sub norm_bitscore {
1096 :     my($self) = @_;
1097 :    
1098 :     return $self->{_bit_score};
1099 :     }
1100 :    
1101 : overbeek 1.4
1102 :    
1103 :     ########################################################################
1104 : overbeek 1.1 package AnnotationO;
1105 : overbeek 1.4 ########################################################################
1106 :    
1107 :     =head1 AnnotationO
1108 :    
1109 :     =cut
1110 :    
1111 :    
1112 :    
1113 :     =head3 new
1114 :    
1115 :     =cut
1116 : overbeek 1.1
1117 :     sub new {
1118 :     my($class,$fid,$timestamp,$who,$text) = @_;
1119 :    
1120 :     my $self = {};
1121 :     $self->{_fid} = $fid;
1122 :     $self->{_timestamp} = $timestamp;
1123 :     $self->{_who} = $who;
1124 :     $self->{_text} = $text;
1125 :     return bless $self, $class;
1126 :     }
1127 :    
1128 : overbeek 1.4
1129 :    
1130 :     =head3 fid
1131 :    
1132 :     =cut
1133 :    
1134 : overbeek 1.1 sub fid {
1135 :     my($self) = @_;
1136 :    
1137 :     return $self->{_fid};
1138 :     }
1139 :    
1140 : overbeek 1.4
1141 :    
1142 :     =head3 timestamp
1143 :    
1144 :     =cut
1145 :    
1146 : overbeek 1.1 sub timestamp {
1147 :     my($self,$convert) = @_;
1148 :    
1149 :     if ($convert)
1150 :     {
1151 :     return scalar localtime($self->{_timestamp});
1152 :     }
1153 :     else
1154 :     {
1155 :     return $self->{_timestamp};
1156 :     }
1157 :     }
1158 :    
1159 : overbeek 1.4
1160 :    
1161 :     =head3 made_by
1162 :    
1163 :     =cut
1164 :    
1165 : overbeek 1.1 sub made_by {
1166 :     my($self) = @_;
1167 :    
1168 :     my $who = $self->{_who};
1169 :     $who =~ s/^master://i;
1170 :     return $who;
1171 :     }
1172 :    
1173 : overbeek 1.4
1174 :    
1175 :     =head3 text
1176 :    
1177 :     =cut
1178 :    
1179 : overbeek 1.1 sub text {
1180 :     my($self) = @_;
1181 :    
1182 :     my $text = $self->{_text};
1183 :     return $text;
1184 :     }
1185 :    
1186 : overbeek 1.4
1187 :     =head3 display
1188 :    
1189 :     =cut
1190 :    
1191 : overbeek 1.1 sub display {
1192 :     my($self) = @_;
1193 :    
1194 :     print join("\t",($self->fid,$self->timestamp(1),$self->made_by)),"\n",$self->text,"\n";
1195 :     }
1196 :    
1197 : overbeek 1.4
1198 :    
1199 :     ########################################################################
1200 : overbeek 1.1 package CouplingO;
1201 : overbeek 1.4 ########################################################################
1202 :     use Data::Dumper;
1203 :    
1204 :     =head3 new
1205 : overbeek 1.1
1206 : overbeek 1.4 =cut
1207 : overbeek 1.1
1208 :     sub new {
1209 :     my($class,$figO,$peg1,$peg2,$sc) = @_;
1210 :    
1211 :     ($peg1 =~ /^fig\|\d+\.\d+\.peg\.\d+$/) || return undef;
1212 :     ($peg2 =~ /^fig\|\d+\.\d+\.peg\.\d+$/) || return undef;
1213 :     my $self = {};
1214 :     $self->{_figO} = $figO;
1215 :     $self->{_peg1} = $peg1;
1216 :     $self->{_peg2} = $peg2;
1217 :     $self->{_sc} = $sc;
1218 :     return bless $self, $class;
1219 :     }
1220 :    
1221 : overbeek 1.4
1222 :    
1223 :     =head3 peg1
1224 :    
1225 :     =cut
1226 :    
1227 : overbeek 1.1 sub peg1 {
1228 :     my($self) = @_;
1229 :    
1230 : overbeek 1.5 my $figO = $self->{_figO};
1231 :     return new FeatureO($figO,$self->{_peg1});
1232 : overbeek 1.1 }
1233 :    
1234 : overbeek 1.4
1235 :    
1236 :     =head3 peg1
1237 :    
1238 :     =cut
1239 :    
1240 : overbeek 1.1 sub peg2 {
1241 :     my($self) = @_;
1242 :    
1243 : overbeek 1.5 my $figO = $self->{_figO};
1244 :     return new FeatureO($figO,$self->{_peg2});
1245 : overbeek 1.1 }
1246 :    
1247 : overbeek 1.4
1248 :    
1249 :     =head3 sc
1250 :    
1251 :     =cut
1252 :    
1253 : overbeek 1.1 sub sc {
1254 :     my($self) = @_;
1255 :    
1256 :     return $self->{_sc};
1257 :     }
1258 :    
1259 : overbeek 1.4
1260 :    
1261 :     =head3 evidence
1262 :    
1263 :     =cut
1264 :    
1265 : overbeek 1.1 sub evidence {
1266 :     my($self) = @_;
1267 :    
1268 :     my $figO = $self->{_figO};
1269 :     my $fig = $figO->{_fig};
1270 :     my @ev = ();
1271 :     foreach my $tuple ($fig->coupling_evidence($self->peg1,$self->peg2))
1272 :     {
1273 :     my($peg3,$peg4,$rep) = @$tuple;
1274 :     push(@ev,[&FeatureO::new('FeatureO',$figO,$peg3),
1275 :     &FeatureO::new('FeatureO',$figO,$peg4),
1276 :     $rep]);
1277 :     }
1278 :     return @ev;
1279 :     }
1280 :    
1281 : overbeek 1.4
1282 :    
1283 :     =head3 display
1284 :    
1285 :     =cut
1286 :    
1287 : overbeek 1.1 sub display {
1288 :     my($self) = @_;
1289 :    
1290 :     print join("\t",($self->peg1,$self->peg2,$self->sc)),"\n";
1291 :     }
1292 :    
1293 : overbeek 1.4
1294 :    
1295 :     ########################################################################
1296 : overbeek 1.1 package SubsystemO;
1297 : overbeek 1.4 ########################################################################
1298 : overbeek 1.1 use Data::Dumper;
1299 :     use Subsystem;
1300 :    
1301 : overbeek 1.4 =head1 SubsystemO
1302 :    
1303 :     =cut
1304 :    
1305 :    
1306 :    
1307 :     =head3 new
1308 :    
1309 :     =cut
1310 :    
1311 : overbeek 1.1 sub new {
1312 :     my($class,$figO,$name) = @_;
1313 :    
1314 :     my $self = {};
1315 :     $self->{_figO} = $figO;
1316 :     $self->{_id} = $name;
1317 :    
1318 :     return bless $self, $class;
1319 :     }
1320 :    
1321 : overbeek 1.4
1322 :    
1323 :     =head3 id
1324 :    
1325 :     =cut
1326 :    
1327 : overbeek 1.1 sub id {
1328 :     my($self) = @_;
1329 :    
1330 :     return $self->{_id};
1331 :     }
1332 :    
1333 : overbeek 1.4
1334 :    
1335 :     =head3 usable
1336 :    
1337 :     =cut
1338 :    
1339 : overbeek 1.1 sub usable {
1340 :     my($self) = @_;
1341 :    
1342 :     my $figO = $self->{_figO};
1343 :     my $fig = $figO->{_fig};
1344 :     return $fig->usable_subsystem($self->id);
1345 :     }
1346 :    
1347 : overbeek 1.4
1348 :    
1349 :     =head3 genomes
1350 :    
1351 :     =cut
1352 :    
1353 : overbeek 1.1 sub genomes {
1354 :     my($self) = @_;
1355 :    
1356 :     my $figO = $self->{_figO};
1357 :     my $subO = $self->{_subO};
1358 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1359 :    
1360 :     return map { &GenomeO::new('GenomeO',$figO,$_) } $subO->get_genomes;
1361 :     }
1362 :    
1363 : overbeek 1.9
1364 :    
1365 : overbeek 1.4 =head3 roles
1366 :    
1367 :     =cut
1368 :    
1369 : overbeek 1.1 sub roles {
1370 :     my($self) = @_;
1371 :    
1372 :     my $figO = $self->{_figO};
1373 :     my $subO = $self->{_subO};
1374 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1375 : overbeek 1.9
1376 : overbeek 1.1 return map { &FunctionalRoleO::new('FunctionalRoleO',$figO,$_) } $subO->get_roles($self->id);
1377 :     }
1378 :    
1379 : overbeek 1.9
1380 :    
1381 : overbeek 1.4 =head3 curator
1382 :    
1383 :     =cut
1384 :    
1385 : overbeek 1.1 sub curator {
1386 :     my($self) = @_;
1387 :    
1388 :     my $figO = $self->{_figO};
1389 :     my $subO = $self->{_subO};
1390 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1391 : overbeek 1.9
1392 :     return $subO->get_curator;
1393 : overbeek 1.1 }
1394 :    
1395 : overbeek 1.4
1396 :    
1397 :    
1398 :     =head3 variant
1399 :    
1400 :     =cut
1401 :    
1402 : overbeek 1.1 sub variant {
1403 :     my($self,$genome) = @_;
1404 :    
1405 :     my $figO = $self->{_figO};
1406 :     my $subO = $self->{_subO};
1407 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1408 :    
1409 :     return $subO->get_variant_code_for_genome($genome->id);
1410 :     }
1411 : overbeek 1.4
1412 :    
1413 :    
1414 :     =head3 pegs_in_cell
1415 :    
1416 :     =cut
1417 :    
1418 : overbeek 1.1 sub pegs_in_cell {
1419 :     my($self,$genome,$role) = @_;
1420 :    
1421 :     my $figO = $self->{_figO};
1422 :     my $subO = $self->{_subO};
1423 :     if (! $subO) { $subO = $self->{_subO} = new Subsystem($self->{_id},$figO->{_fig}); }
1424 :    
1425 :     return $subO->get_pegs_from_cell($genome->id,$role->id);
1426 :     }
1427 :    
1428 : overbeek 1.4
1429 :    
1430 :     ########################################################################
1431 : overbeek 1.1 package FunctionalRoleO;
1432 : overbeek 1.4 ########################################################################
1433 :     use Data::Dumper;
1434 : overbeek 1.1
1435 : overbeek 1.4 =head1 FunctionalRoleO
1436 :    
1437 : overbeek 1.9 Methods for accessing the functional roles of features.
1438 :    
1439 : overbeek 1.4 =cut
1440 :    
1441 :    
1442 :     =head3 new
1443 :    
1444 :     =cut
1445 : overbeek 1.1
1446 :     sub new {
1447 :     my($class,$figO,$fr) = @_;
1448 :    
1449 :     my $self = {};
1450 :     $self->{_figO} = $figO;
1451 :     $self->{_id} = $fr;
1452 :     return bless $self, $class;
1453 :     }
1454 :    
1455 : overbeek 1.4
1456 :    
1457 :     =head3 id
1458 :    
1459 :     =cut
1460 :    
1461 : overbeek 1.1 sub id {
1462 :     my($self) = @_;
1463 :    
1464 :     return $self->{_id};
1465 :     }
1466 :    
1467 : overbeek 1.4
1468 :    
1469 :     ########################################################################
1470 : overbeek 1.1 package FigFamO;
1471 : overbeek 1.4 ########################################################################
1472 : overbeek 1.1 use FigFams;
1473 :     use FigFam;
1474 :    
1475 : overbeek 1.4
1476 :     =head1 FigFamO
1477 :    
1478 :     =cut
1479 :    
1480 :    
1481 :     =head3 new
1482 :    
1483 :     =cut
1484 :    
1485 : overbeek 1.1 sub new {
1486 :     my($class,$figO,$id) = @_;
1487 :    
1488 :     my $self = {};
1489 :     $self->{_figO} = $figO;
1490 :     $self->{_id} = $id;
1491 :     return bless $self, $class;
1492 :     }
1493 :    
1494 : overbeek 1.4
1495 :    
1496 :     =head3 id
1497 :    
1498 :     =cut
1499 :    
1500 : overbeek 1.1 sub id {
1501 :     my($self) = @_;
1502 :    
1503 :     return $self->{_id};
1504 :     }
1505 :    
1506 : overbeek 1.4
1507 :     =head3 function
1508 :    
1509 :     =cut
1510 :    
1511 : overbeek 1.1 sub function {
1512 :     my($self) = @_;
1513 :    
1514 :     my $fig = $self->{_figO}->{_fig};
1515 :     my $famO = $self->{_famO};
1516 :     if (! $famO) { $famO = $self->{_famO} = &FigFam::new('FigFam',$fig,$self->id) }
1517 :    
1518 :     return $famO->family_function;
1519 :     }
1520 :    
1521 : overbeek 1.4
1522 :    
1523 :     =head3 members
1524 :    
1525 :     =cut
1526 :    
1527 : overbeek 1.1 sub members {
1528 :     my($self) = @_;
1529 :    
1530 :     my $figO = $self->{_figO};
1531 :     my $fig = $figO->{_fig};
1532 :     my $famO = $self->{_famO};
1533 :     if (! $famO) { $famO = $self->{_famO} = &FigFam::new('FigFam',$fig,$self->id) }
1534 :    
1535 :     return map { &FigFamO::new('FigFamO',$figO,$_) } $famO->list_members;
1536 :     }
1537 :    
1538 : overbeek 1.4
1539 :    
1540 :     =head3 rep_seqs
1541 :    
1542 :     =cut
1543 :    
1544 : overbeek 1.1 sub rep_seqs {
1545 :     my($self) = @_;
1546 :    
1547 :     my $figO = $self->{_figO};
1548 :     my $fig = $figO->{_fig};
1549 :     my $famO = $self->{_famO};
1550 :     if (! $famO) { $famO = $self->{_famO} = &FigFam::new('FigFam',$fig,$self->id) }
1551 :    
1552 :     return $famO->representatives;
1553 :     }
1554 :    
1555 : overbeek 1.4
1556 :    
1557 :     =head3 should_be_member
1558 :    
1559 :     =cut
1560 :    
1561 : overbeek 1.1 sub should_be_member {
1562 :     my($self,$seq) = @_;
1563 :    
1564 :     my $figO = $self->{_figO};
1565 :     my $fig = $figO->{_fig};
1566 :     my $famO = $self->{_famO};
1567 :     if (! $famO) { $famO = $self->{_famO} = &FigFam::new('FigFam',$fig,$self->id) }
1568 :    
1569 :     return $famO->should_be_member($seq);
1570 :     }
1571 :    
1572 :    
1573 :    
1574 : overbeek 1.4 =head3 display
1575 :    
1576 :     =cut
1577 :    
1578 : overbeek 1.1 sub display {
1579 :     my($self) = @_;
1580 :    
1581 :     print join("\t",($self->id,$self->function)),"\n";
1582 :     }
1583 :    
1584 :    
1585 :    
1586 : overbeek 1.4 ########################################################################
1587 : overbeek 1.1 package Attribute;
1588 : overbeek 1.4 ########################################################################
1589 :     =head1 Attribute
1590 :    
1591 : overbeek 1.9 (Note yet implemented.)
1592 :    
1593 : overbeek 1.4 =cut
1594 : overbeek 1.1
1595 :     1;
1596 : overbeek 1.4 __END__
1597 :    
1598 :     =head1 Examples
1599 :    
1600 :     =head3 Display all complete, prokaryotic genomes
1601 :    
1602 :     use FIGO;
1603 :     my $figO = new FIGO;
1604 :    
1605 :     foreach $genome ($figO->genomes('complete','prokaryotic'))
1606 :     {
1607 :     $genome->display;
1608 :     }
1609 :    
1610 :     #---------------------------------------------
1611 :    
1612 :     use FIG;
1613 :     my $fig = new FIG;
1614 :    
1615 :     foreach $genome (grep { $fig->is_prokaryotic($_) } $fig->genomes('complete'))
1616 :     {
1617 :     print join("\t",("Genome",$genome,$fig->genus_species($genome))),"\n";
1618 :     }
1619 :    
1620 :     ###############################################
1621 :    
1622 :     =head3 Show how to access contigs and extract sequence
1623 :    
1624 :     use FIGO;
1625 :     my $figO = new FIGO;
1626 :    
1627 :     $genomeId = '83333.1';
1628 :     my $genome = new GenomeO($figO,$genomeId);
1629 :    
1630 :     foreach $contig ($genome->contigs_of)
1631 :     {
1632 :     $tag1 = $contig->dna_seq(1,10);
1633 :     $tag2 = $contig->dna_seq(10,1);
1634 :     print join("\t",($tag1,$tag2,$contig->id,$contig->contig_length)),"\n";
1635 :     }
1636 :    
1637 :     #---------------------------------------------
1638 :    
1639 :     use FIG;
1640 :     my $fig = new FIG;
1641 :    
1642 :     $genomeId = '83333.1';
1643 :    
1644 :     $contig_lengths = $fig->contig_lengths($genomeId);
1645 :    
1646 :     foreach $contig ($fig->contigs_of($genomeId))
1647 :     {
1648 :     $tag1 = $fig->dna_seq($genomeId,join("_",($contig,1,10)));
1649 :     $tag2 = $fig->dna_seq($genomeId,join("_",($contig,10,1)));
1650 :     print join("\t",($tag1,$tag2,$contig,$contig_lengths->{$contig})),"\n";
1651 :     }
1652 :    
1653 :     ###############################################
1654 :    
1655 :     ### accessing data related to features
1656 :    
1657 :     use FIGO;
1658 :     my $figO = new FIGO;
1659 :    
1660 :     my $genome = new GenomeO($figO,"83333.1");
1661 :     my $peg = "fig|83333.1.peg.4";
1662 :     my $pegO = new FeatureO($figO,$peg);
1663 :    
1664 :     print join("\t",$pegO->id,$pegO->location,$pegO->function_of),"\n",
1665 :     $pegO->dna_seq,"\n",
1666 :     $pegO->prot_seq,"\n";
1667 :    
1668 :     foreach $fidO ($genome->features_of('rna'))
1669 :     {
1670 :     print join("\t",$fidO->id,$fidO->location,$fidO->function_of),"\n";
1671 :     }
1672 :    
1673 :     #---------------------------------------------
1674 :    
1675 :    
1676 :     use FIG;
1677 :     my $fig = new FIG;
1678 :    
1679 :     my $genome = "83333.1";
1680 :     my $peg = "fig|83333.1.peg.4";
1681 :    
1682 :     print join("\t",$peg,scalar $fig->feature_location($peg),scalar $fig->function_of($peg)),"\n",
1683 :     $fig->dna_seq($genome,$fig->feature_location($peg)),"\n",
1684 :     $fig->get_translation($peg),"\n";
1685 :    
1686 :     foreach $fid ($fig->all_features($genome,'rna'))
1687 :     {
1688 :     print join("\t",$fid,scalar $fig->feature_location($fid),scalar $fig->function_of($fid)),"\n";
1689 :     }
1690 :    
1691 :     ###############################################
1692 :    
1693 :     ### accessing similarities
1694 :    
1695 :     use FIGO;
1696 :     my $figO = new FIGO;
1697 :    
1698 :     $peg = "fig|83333.1.peg.4";
1699 :     $pegO = new FeatureO($figO,$peg);
1700 :    
1701 :     @sims = $pegO->sims; # use sims( -all => 1, -max => 10000, -cutoff => 1.0e-20) to all
1702 :     # sims (including non-FIG sequences
1703 :     foreach $sim (@sims)
1704 :     {
1705 :     $peg2 = $sim->id2;
1706 :     $pegO2 = new FeatureO($figO,$peg2);
1707 :     $func = $pegO2->function_of;
1708 :     $sc = $sim->psc;
1709 :     print join("\t",($peg2,$sc,$func)),"\n";
1710 :     }
1711 :    
1712 :     #---------------------------------------------
1713 :    
1714 :    
1715 :     use FIG;
1716 :     my $fig = new FIG;
1717 :    
1718 :     $peg = "fig|83333.1.peg.4";
1719 :    
1720 :     @sims = $fig->sims($peg,1000,1.0e-5,"fig");
1721 :     foreach $sim (@sims)
1722 :     {
1723 :     $peg2 = $sim->id2;
1724 :     $func = $fig->function_of($peg2);
1725 :     $sc = $sim->psc;
1726 :     print join("\t",($peg2,$sc,$func)),"\n";
1727 :     }
1728 :    
1729 :     ###############################################
1730 :    
1731 :     ### accessing BBHs
1732 :    
1733 :     use FIGO;
1734 :     my $figO = new FIGO;
1735 :    
1736 :     $peg = "fig|83333.1.peg.4";
1737 :     $pegO = new FeatureO($figO,$peg);
1738 :    
1739 :     @bbhs = $pegO->bbhs;
1740 :     foreach $bbh (@bbhs)
1741 :     {
1742 :     $peg2 = $bbh->peg2;
1743 :     $pegO2 = new FeatureO($figO,$peg2);
1744 :     $func = $pegO2->function_of;
1745 :     $sc = $bbh->psc;
1746 :     print join("\t",($peg2,$sc,$func)),"\n";
1747 :     }
1748 :    
1749 :     #---------------------------------------------
1750 :    
1751 :     use FIG;
1752 :     my $fig = new FIG;
1753 :    
1754 :     $peg = "fig|83333.1.peg.4";
1755 :    
1756 :     @bbhs = $fig->bbhs($peg);
1757 :     foreach $bbh (@bbhs)
1758 :     {
1759 :     ($peg2,$sc,$bit_score) = @$bbh;
1760 :     $func = $fig->function_of($peg2);
1761 :     print join("\t",($peg2,$sc,$func)),"\n";
1762 :     }
1763 :    
1764 :     ###############################################
1765 :    
1766 :     ### accessing annotations
1767 :    
1768 :     use FIGO;
1769 :     my $figO = new FIGO;
1770 :    
1771 :     $peg = "fig|83333.1.peg.4";
1772 :     $pegO = new FeatureO($figO,$peg);
1773 :    
1774 :     @annotations = $pegO->annotations;
1775 :    
1776 :     foreach $ann (@annotations)
1777 :     {
1778 :     print join("\n",$ann->fid,$ann->timestamp(1),$ann->made_by,$ann->text),"\n\n";
1779 :     }
1780 :    
1781 :     #---------------------------------------------
1782 :    
1783 :     use FIG;
1784 :     my $fig = new FIG;
1785 :    
1786 :     $peg = "fig|83333.1.peg.4";
1787 :     @annotations = $fig->feature_annotations($peg);
1788 :     foreach $_ (@annotations)
1789 :     {
1790 :     (undef,$ts,$who,$text) = @$_;
1791 :     $who =~ s/master://i;
1792 :     print "$ts\n$who\n$text\n\n";
1793 :     }
1794 :    
1795 :     ###############################################
1796 :    
1797 :     ### accessing coupling data
1798 :    
1799 :    
1800 :     use FIGO;
1801 :     my $figO = new FIGO;
1802 :    
1803 :     my $peg = "fig|83333.1.peg.4";
1804 :     my $pegO = new FeatureO($figO,$peg);
1805 :     foreach $coupled ($pegO->coupled_to)
1806 :     {
1807 :     print join("\t",($coupled->peg1,$coupled->peg2,$coupled->sc)),"\n";
1808 :     foreach $tuple ($coupled->evidence)
1809 :     {
1810 :     my($peg3O,$peg4O,$rep) = @$tuple;
1811 :     print "\t",join("\t",($peg3O->id,$peg4O->id,$rep)),"\n";
1812 :     }
1813 :     print "\n";
1814 :     }
1815 :    
1816 :     #---------------------------------------------
1817 :    
1818 :    
1819 :     use FIG;
1820 :     my $fig = new FIG;
1821 :    
1822 :     my $peg1 = "fig|83333.1.peg.4";
1823 :     foreach $coupled ($fig->coupled_to($peg1))
1824 :     {
1825 :     ($peg2,$sc) = @$coupled;
1826 :     print join("\t",($peg1,$peg2,$sc)),"\n";
1827 :     foreach $tuple ($fig->coupling_evidence($peg1,$peg2))
1828 :     {
1829 :     my($peg3,$peg4,$rep) = @$tuple;
1830 :     print "\t",join("\t",($peg3,$peg4,$rep)),"\n";
1831 :     }
1832 :     print "\n";
1833 :     }
1834 :    
1835 :     ###############################################
1836 :    
1837 :     =head3 Accessing Subsystem data
1838 :    
1839 :     use FIGO;
1840 :     my $figO = new FIGO;
1841 :    
1842 :     foreach $sub ($figO->subsystems)
1843 :     {
1844 :     if ($sub->usable)
1845 :     {
1846 :     print join("\t",($sub->id,$sub->curator)),"\n";
1847 :    
1848 :     print "\tRoles\n";
1849 :     @roles = $sub->roles;
1850 :     foreach $role (@roles)
1851 :     {
1852 :     print "\t\t",join("\t",($role->id)),"\n";
1853 :     }
1854 :    
1855 :     print "\tGenomes\n";
1856 :     foreach $genome ($sub->genomes)
1857 :     {
1858 :     print "\t\t",join("\t",($sub->variant($genome),
1859 :     $genome->id,
1860 :     $genome->genus_species)),"\n";
1861 :     @pegs = ();
1862 :     foreach $role (@roles)
1863 :     {
1864 :     push(@pegs,$sub->pegs_in_cell($genome,$role));
1865 :     }
1866 :     print "\t\t\t",join(",",@pegs),"\n";
1867 :     }
1868 :     }
1869 :     }
1870 :    
1871 :     #---------------------------------------------
1872 :    
1873 :     use FIG;
1874 :     my $fig = new FIG;
1875 :    
1876 :     foreach $sub (grep { $fig->usable_subsystem($_) } $fig->all_subsystems)
1877 :     {
1878 :     $subO = new Subsystem($sub,$fig);
1879 :     $curator = $subO->get_curator;
1880 :     print join("\t",($sub,$curator)),"\n";
1881 :    
1882 :     print "\tRoles\n";
1883 :     @roles = $subO->get_roles;
1884 :     foreach $role (@roles)
1885 :     {
1886 :     print "\t\t",join("\t",($role)),"\n";
1887 :     }
1888 :    
1889 :     print "\tGenomes\n";
1890 :     foreach $genome ($subO->get_genomes)
1891 :     {
1892 :     print "\t\t",join("\t",($subO->get_variant_code_for_genome($genome),
1893 :     $genome,
1894 :     $fig->genus_species($genome))),"\n";
1895 :     foreach $role (@roles)
1896 :     {
1897 :     push(@pegs,$subO->get_pegs_from_cell($genome,$role));
1898 :     }
1899 :     print "\t\t\t",join(",",@pegs),"\n";
1900 :     }
1901 :     print "\n";
1902 :     }
1903 :    
1904 :     ###############################################
1905 :    
1906 :     =head3 Accessing FIGfams
1907 :    
1908 :     use FIGO;
1909 :     my $figO = new FIGO;
1910 :    
1911 :     foreach $fam ($figO->all_figfams)
1912 :     {
1913 :     print join("\t",($fam->id,$fam->function)),"\n";
1914 :     foreach $pegO ($fam->members)
1915 :     {
1916 :     $peg = $pegO->id;
1917 :     print "\t$peg\n";
1918 :     }
1919 :     }
1920 :    
1921 :     #---------------------------------------------
1922 :    
1923 :     use FIG;
1924 :     use FigFam;
1925 :     use FigFams;
1926 :    
1927 :     my $fig = new FIG;
1928 :     my $figfams = new FigFams($fig);
1929 :    
1930 :     foreach $fam ($figfams->all_families)
1931 :     {
1932 :     my $figfam = new FigFam($fig,$fam);
1933 :     print join("\t",($fam,$figfam->family_function)),"\n";
1934 :     foreach $peg ($figfam->list_members)
1935 :     {
1936 :     print "\t$peg\n";
1937 :     }
1938 :     }
1939 :    
1940 :     ###############################################
1941 :    
1942 :     =head3 Placing a sequence into a FIGfam
1943 :    
1944 :     use FIGO;
1945 :     my $figO = new FIGO;
1946 :    
1947 :     $seq = "MKLYNLKDHNEQVSFAQAVTQGLGKNQGLFFPHDLPEFSLTEIDEMLKLDFVTRSAKILS
1948 :     AFIGDEIPQEILEERVRAAFAFPAPVANVESDVGCLELFHGPTLAFKDFGGRFMAQMLTH
1949 :     IAGDKPVTILTATSGDTGAAVAHAFYGLPNVKVVILYPRGKISPLQEKLFCTLGGNIETV
1950 :     AIDGDFDACQALVKQAFDDEELKVALGLNSANSINISRLLAQICYYFEAVAQLPQETRNQ
1951 :     LVVSVPSGNFGDLTAGLLAKSLGLPVKRFIAATNVNDTVPRFLHDGQWSPKATQATLSNA
1952 :     MDVSQPNNWPRVEELFRRKIWQLKELGYAAVDDETTQQTMRELKELGYTSEPHAAVAYRA
1953 :     LRDQLNPGEYGLFLGTAHPAKFKESVEAILGETLDLPKELAERADLPLLSHNLPADFAAL
1954 :     RKLMMNHQ";
1955 :     $seq =~ s/\n//gs;
1956 :    
1957 :     my($fam,$sims) = $figO->family_containing($seq);
1958 :    
1959 :     if ($fam)
1960 :     {
1961 :     print join("\t",($fam->id,$fam->function)),"\n";
1962 :     print &Dumper($sims);
1963 :     }
1964 :     else
1965 :     {
1966 :     print "Could not place it in a family\n";
1967 :     }
1968 :    
1969 :     #---------------------------------------------
1970 :    
1971 :     use FIG;
1972 :     use FigFam;
1973 :     use FigFams;
1974 :    
1975 :     my $fig = new FIG;
1976 :     my $figfams = new FigFams($fig);
1977 :    
1978 :     $seq = "MKLYNLKDHNEQVSFAQAVTQGLGKNQGLFFPHDLPEFSLTEIDEMLKLDFVTRSAKILS
1979 :     AFIGDEIPQEILEERVRAAFAFPAPVANVESDVGCLELFHGPTLAFKDFGGRFMAQMLTH
1980 :     IAGDKPVTILTATSGDTGAAVAHAFYGLPNVKVVILYPRGKISPLQEKLFCTLGGNIETV
1981 :     AIDGDFDACQALVKQAFDDEELKVALGLNSANSINISRLLAQICYYFEAVAQLPQETRNQ
1982 :     LVVSVPSGNFGDLTAGLLAKSLGLPVKRFIAATNVNDTVPRFLHDGQWSPKATQATLSNA
1983 :     MDVSQPNNWPRVEELFRRKIWQLKELGYAAVDDETTQQTMRELKELGYTSEPHAAVAYRA
1984 :     LRDQLNPGEYGLFLGTAHPAKFKESVEAILGETLDLPKELAERADLPLLSHNLPADFAAL
1985 :     RKLMMNHQ";
1986 :     $seq =~ s/\n//gs;
1987 :    
1988 :     my($fam,$sims) = $figfams->place_in_family($seq);
1989 :    
1990 :     if ($fam)
1991 :     {
1992 :     print join("\t",($fam->family_id,$fam->family_function)),"\n";
1993 :     print &Dumper($sims);
1994 :     }
1995 :     else
1996 :     {
1997 :     print "Could not place it in a family\n";
1998 :     }
1999 :    
2000 :     ###############################################
2001 :    
2002 :     =head3 Getting representative sequences for a FIGfam
2003 :    
2004 :     use FIGO;
2005 :     my $figO = new FIGO;
2006 :    
2007 :     $fam = "FIG102446";
2008 :     my $famO = &FigFamO::new('FigFamO',$figO,$fam);
2009 :     my @rep_seqs = $famO->rep_seqs;
2010 :    
2011 :     foreach $seq (@rep_seqs)
2012 :     {
2013 :     print ">query\n$seq\n";
2014 :     }
2015 :    
2016 :     #---------------------------------------------
2017 :    
2018 :     use FIG;
2019 :     use FigFam;
2020 :     use FigFams;
2021 :    
2022 :     my $fig = new FIG;
2023 :    
2024 :     $fam = "FIG102446";
2025 :     my $famO = new FigFam($fig,$fam);
2026 :     my @rep_seqs = $famO->representatives;
2027 :    
2028 :     foreach $seq (@rep_seqs)
2029 :     {
2030 :     print ">query\n$seq\n";
2031 :     }
2032 :    
2033 :    
2034 :     ###############################################
2035 :    
2036 :    
2037 :     =head3 Testing for membership in FIGfam
2038 :    
2039 :     use FIGO;
2040 :     my $figO = new FIGO;
2041 :    
2042 :     $seq = "MKLYNLKDHNEQVSFAQAVTQGLGKNQGLFFPHDLPEFSLTEIDEMLKLDFVTRSAKILS
2043 :     AFIGDEIPQEILEERVRAAFAFPAPVANVESDVGCLELFHGPTLAFKDFGGRFMAQMLTH
2044 :     IAGDKPVTILTATSGDTGAAVAHAFYGLPNVKVVILYPRGKISPLQEKLFCTLGGNIETV
2045 :     AIDGDFDACQALVKQAFDDEELKVALGLNSANSINISRLLAQICYYFEAVAQLPQETRNQ
2046 :     LVVSVPSGNFGDLTAGLLAKSLGLPVKRFIAATNVNDTVPRFLHDGQWSPKATQATLSNA
2047 :     MDVSQPNNWPRVEELFRRKIWQLKELGYAAVDDETTQQTMRELKELGYTSEPHAAVAYRA
2048 :     LRDQLNPGEYGLFLGTAHPAKFKESVEAILGETLDLPKELAERADLPLLSHNLPADFAAL
2049 :     RKLMMNHQ";
2050 :     $seq =~ s/\n//gs;
2051 :    
2052 :     $fam = "FIG102446";
2053 :     my $famO = &FigFamO::new('FigFamO',$figO,$fam);
2054 :     my($should_be, $sims) = $famO->should_be_member($seq);
2055 :    
2056 :     if ($should_be)
2057 :     {
2058 :     print join("\t",($famO->id,$famO->function)),"\n";
2059 :     print &Dumper($sims);
2060 :     }
2061 :     else
2062 :     {
2063 :     print "Sequence should not be added to family\n";
2064 :     }
2065 :    
2066 :     #---------------------------------------------
2067 :    
2068 :     use FIG;
2069 :     use FigFam;
2070 :     use FigFams;
2071 :    
2072 :     my $fig = new FIG;
2073 :    
2074 :     $seq = "MKLYNLKDHNEQVSFAQAVTQGLGKNQGLFFPHDLPEFSLTEIDEMLKLDFVTRSAKILS
2075 :     AFIGDEIPQEILEERVRAAFAFPAPVANVESDVGCLELFHGPTLAFKDFGGRFMAQMLTH
2076 :     IAGDKPVTILTATSGDTGAAVAHAFYGLPNVKVVILYPRGKISPLQEKLFCTLGGNIETV
2077 :     AIDGDFDACQALVKQAFDDEELKVALGLNSANSINISRLLAQICYYFEAVAQLPQETRNQ
2078 :     LVVSVPSGNFGDLTAGLLAKSLGLPVKRFIAATNVNDTVPRFLHDGQWSPKATQATLSNA
2079 :     MDVSQPNNWPRVEELFRRKIWQLKELGYAAVDDETTQQTMRELKELGYTSEPHAAVAYRA
2080 :     LRDQLNPGEYGLFLGTAHPAKFKESVEAILGETLDLPKELAERADLPLLSHNLPADFAAL
2081 :     RKLMMNHQ";
2082 :     $seq =~ s/\n//gs;
2083 :    
2084 :     $fam = "FIG102446";
2085 :     my $famO = new FigFam($fig,$fam);
2086 :     my($should_be, $sims) = $famO->should_be_member($seq);
2087 :    
2088 :     if ($should_be)
2089 :     {
2090 :     print join("\t",($famO->family_id,$famO->family_function)),"\n";
2091 :     print &Dumper($sims);
2092 :     }
2093 :     else
2094 :     {
2095 :     print "Sequence should not be added to family\n";
2096 :     }
2097 :    
2098 :     =cut
2099 :    

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3