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

Annotation of /FigKernelPackages/FIGO.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3