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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : efrank 1.1 package FIG;
2 :    
3 :     use DBrtns;
4 :     use Sim;
5 :     use Blast;
6 :     use FIG_Config;
7 : overbeek 1.36 use tree_utilities;
8 : olson 1.79
9 :     #
10 :     # Conditionally evaluate this in case its prerequisites are not available.
11 :     #
12 :    
13 :     our $ClearinghouseOK = eval {
14 :     require Clearinghouse;
15 :     };
16 : efrank 1.1
17 : olson 1.10 use IO::Socket;
18 :    
19 : efrank 1.1 use FileHandle;
20 :    
21 :     use Carp;
22 :     use Data::Dumper;
23 : overbeek 1.25 use Time::Local;
24 : efrank 1.1
25 :     use strict;
26 :     use Fcntl qw/:flock/; # import LOCK_* constants
27 :    
28 :     sub new {
29 :     my($class) = @_;
30 :    
31 :     my $rdbH = new DBrtns;
32 :     bless {
33 :     _dbf => $rdbH,
34 :     }, $class;
35 :     }
36 :    
37 :     sub DESTROY {
38 :     my($self) = @_;
39 :     my($rdbH);
40 :    
41 :     if ($rdbH = $self->db_handle)
42 :     {
43 :     $rdbH->DESTROY;
44 :     }
45 :     }
46 :    
47 : overbeek 1.7 sub delete_genomes {
48 :     my($self,$genomes) = @_;
49 :     my $tmpD = "$FIG_Config::temp/tmp.deleted.$$";
50 :     my $tmp_Data = "$FIG_Config::temp/Data.$$";
51 :    
52 :     my %to_del = map { $_ => 1 } @$genomes;
53 :     open(TMP,">$tmpD") || die "could not open $tmpD";
54 :    
55 :     my $genome;
56 :     foreach $genome ($self->genomes)
57 :     {
58 :     if (! $to_del{$genome})
59 :     {
60 :     print TMP "$genome\n";
61 :     }
62 :     }
63 :     close(TMP);
64 :    
65 :     &run("extract_genomes $tmpD $FIG_Config::data $tmp_Data");
66 : overbeek 1.47
67 :     # &run("mv $FIG_Config::data $FIG_Config::data.deleted; mv $tmp_Data $FIG_Config::data; fig load_all; rm -rf $FIG_Config::data.deleted");
68 :    
69 :     &run("mv $FIG_Config::data $FIG_Config::data.deleted");
70 :     &run("mv $tmp_Data $FIG_Config::data");
71 :     &run("fig load_all");
72 :     &run("rm -rf $FIG_Config::data.deleted");
73 : overbeek 1.7 }
74 :    
75 : efrank 1.1 sub add_genome {
76 :     my($self,$genomeF) = @_;
77 :    
78 :     my $rc = 0;
79 : overbeek 1.7 if (($genomeF =~ /((.*\/)?(\d+\.\d+))$/) && (! -d "$FIG_Config::organisms/$3"))
80 : efrank 1.1 {
81 :     my $genome = $3;
82 :     my @errors = `$FIG_Config::bin/verify_genome_directory $genomeF`;
83 :     if (@errors == 0)
84 :     {
85 : overbeek 1.80 &run("cp -r $genomeF $FIG_Config::organisms; chmod -R 777 $FIG_Config::organisms/$genomeF");
86 : overbeek 1.18 &run("index_contigs $genome");
87 :     &run("compute_genome_counts $genome");
88 : efrank 1.1 &run("load_features $genome");
89 :     $rc = 1;
90 :     if (-s "$FIG_Config::organisms/$genome/Features/peg/fasta")
91 :     {
92 :     &run("index_translations $genome");
93 :     my @tmp = `cut -f1 $FIG_Config::organisms/$genome/Features/peg/tbl`;
94 : golsen 1.44 chomp @tmp;
95 : overbeek 1.7 &run("cat $FIG_Config::organisms/$genome/Features/peg/fasta >> $FIG_Config::data/Global/nr");
96 :     &make_similarities(\@tmp);
97 : efrank 1.1 }
98 :     if ((-s "$FIG_Config::organisms/$genome/assigned_functions") ||
99 :     (-d "$FIG_Config::organisms/$genome/UserModels"))
100 :     {
101 :     &run("add_assertions_of_function $genome");
102 :     }
103 :     }
104 :     }
105 :     return $rc;
106 :     }
107 :    
108 :     sub make_similarities {
109 :     my($fids) = @_;
110 :     my $fid;
111 :    
112 :     open(TMP,">>$FIG_Config::global/queued_similarities")
113 :     || die "could not open $FIG_Config::global/queued_similarities";
114 :     foreach $fid (@$fids)
115 :     {
116 :     print TMP "$fid\n";
117 :     }
118 :     close(TMP);
119 : olson 1.10 }
120 :    
121 :     sub get_local_hostname {
122 : olson 1.52
123 :     #
124 :     # See if there is a FIGdisk/config/hostname file. If there
125 :     # is, force the hostname to be that.
126 :     #
127 :    
128 :     my $hostfile = "$FIG_Config::fig_disk/config/hostname";
129 :     if (-f $hostfile)
130 :     {
131 :     my $fh;
132 :     if (open($fh, $hostfile))
133 :     {
134 :     my $hostname = <$fh>;
135 :     chomp($hostname);
136 :     return $hostname;
137 :     }
138 :     }
139 :    
140 : olson 1.10 #
141 :     # First check to see if we our hostname is correct.
142 :     #
143 :     # Map it to an IP address, and try to bind to that ip.
144 :     #
145 :    
146 :     my $tcp = getprotobyname('tcp');
147 :    
148 :     my $hostname = `hostname`;
149 : golsen 1.44 chomp($hostname);
150 : olson 1.10
151 :     my @hostent = gethostbyname($hostname);
152 :    
153 :     if (@hostent > 0)
154 :     {
155 :     my $sock;
156 :     my $ip = $hostent[4];
157 :    
158 :     socket($sock, PF_INET, SOCK_STREAM, $tcp);
159 :     if (bind($sock, sockaddr_in(0, $ip)))
160 :     {
161 :     #
162 :     # It worked. Reverse-map back to a hopefully fqdn.
163 :     #
164 :    
165 :     my @rev = gethostbyaddr($ip, AF_INET);
166 :     if (@rev > 0)
167 :     {
168 : olson 1.28 my $host = $rev[0];
169 :     #
170 :     # Check to see if we have a FQDN.
171 :     #
172 :    
173 :     if ($host =~ /\./)
174 :     {
175 :     #
176 :     # Good.
177 :     #
178 :     return $host;
179 :     }
180 :     else
181 :     {
182 :     #
183 :     # We didn't get a fqdn; bail and return the IP address.
184 :     #
185 :     return get_hostname_by_adapter()
186 :     }
187 : olson 1.10 }
188 :     else
189 :     {
190 :     return inet_ntoa($ip);
191 :     }
192 :     }
193 :     else
194 :     {
195 :     #
196 :     # Our hostname must be wrong; we can't bind to the IP
197 :     # address it maps to.
198 :     # Return the name associated with the adapter.
199 :     #
200 :     return get_hostname_by_adapter()
201 :     }
202 :     }
203 :     else
204 :     {
205 :     #
206 :     # Our hostname isn't known to DNS. This isn't good.
207 :     # Return the name associated with the adapter.
208 :     #
209 :     return get_hostname_by_adapter()
210 :     }
211 :     }
212 :    
213 :     sub get_hostname_by_adapter {
214 :     #
215 :     # Attempt to determine our local hostname based on the
216 :     # network environment.
217 :     #
218 :     # This implementation reads the routing table for the default route.
219 :     # We then look at the interface config for the interface that holds the default.
220 :     #
221 :     #
222 :     # Linux routing table:
223 :     # [olson@yips 0.0.0]$ netstat -rn
224 :     # Kernel IP routing table
225 :     # Destination Gateway Genmask Flags MSS Window irtt Iface
226 :     # 140.221.34.32 0.0.0.0 255.255.255.224 U 0 0 0 eth0
227 :     # 169.254.0.0 0.0.0.0 255.255.0.0 U 0 0 0 eth0
228 :     # 127.0.0.0 0.0.0.0 255.0.0.0 U 0 0 0 lo
229 :     # 0.0.0.0 140.221.34.61 0.0.0.0 UG 0 0 0 eth0
230 :     #
231 :     # Mac routing table:
232 :     #
233 :     # bash-2.05a$ netstat -rn
234 :     # Routing tables
235 :     #
236 :     # Internet:
237 :     # Destination Gateway Flags Refs Use Netif Expire
238 :     # default 140.221.11.253 UGSc 12 120 en0
239 :     # 127.0.0.1 127.0.0.1 UH 16 8415486 lo0
240 :     # 140.221.8/22 link#4 UCS 12 0 en0
241 :     # 140.221.8.78 0:6:5b:f:51:c4 UHLW 0 183 en0 408
242 :     # 140.221.8.191 0:3:93:84:ab:e8 UHLW 0 92 en0 622
243 :     # 140.221.8.198 0:e0:98:8e:36:e2 UHLW 0 5 en0 691
244 :     # 140.221.9.6 0:6:5b:f:51:d6 UHLW 1 63 en0 1197
245 :     # 140.221.10.135 0:d0:59:34:26:34 UHLW 2 2134 en0 1199
246 :     # 140.221.10.152 0:30:1b:b0:ec:dd UHLW 1 137 en0 1122
247 :     # 140.221.10.153 127.0.0.1 UHS 0 0 lo0
248 :     # 140.221.11.37 0:9:6b:53:4e:4b UHLW 1 624 en0 1136
249 :     # 140.221.11.103 0:30:48:22:59:e6 UHLW 3 973 en0 1016
250 :     # 140.221.11.224 0:a:95:6f:7:10 UHLW 1 1 en0 605
251 :     # 140.221.11.237 0:1:30:b8:80:c0 UHLW 0 0 en0 1158
252 :     # 140.221.11.250 0:1:30:3:1:0 UHLW 0 0 en0 1141
253 :     # 140.221.11.253 0:d0:3:e:70:a UHLW 13 0 en0 1199
254 :     # 169.254 link#4 UCS 0 0 en0
255 :     #
256 :     # Internet6:
257 :     # Destination Gateway Flags Netif Expire
258 :     # UH lo0
259 :     # fe80::%lo0/64 Uc lo0
260 :     # link#1 UHL lo0
261 :     # fe80::%en0/64 link#4 UC en0
262 :     # 0:a:95:a8:26:68 UHL lo0
263 :     # ff01::/32 U lo0
264 :     # ff02::%lo0/32 UC lo0
265 :     # ff02::%en0/32 link#4 UC en0
266 :    
267 :     my($fh);
268 :    
269 :     if (!open($fh, "netstat -rn |"))
270 :     {
271 :     warn "Cannot run netstat to determine local IP address\n";
272 :     return "localhost";
273 :     }
274 :    
275 :     my $interface_name;
276 :    
277 :     while (<$fh>)
278 :     {
279 :     my @cols = split();
280 :    
281 :     if ($cols[0] eq "default" || $cols[0] eq "0.0.0.0")
282 :     {
283 :     $interface_name = $cols[$#cols];
284 :     }
285 :     }
286 :     close($fh);
287 :    
288 : olson 1.11 # print "Default route on $interface_name\n";
289 : olson 1.10
290 :     #
291 :     # Find ifconfig.
292 :     #
293 :    
294 :     my $ifconfig;
295 :    
296 :     for my $dir ((split(":", $ENV{PATH}), "/sbin", "/usr/sbin"))
297 :     {
298 :     if (-x "$dir/ifconfig")
299 :     {
300 :     $ifconfig = "$dir/ifconfig";
301 :     last;
302 :     }
303 :     }
304 :    
305 :     if ($ifconfig eq "")
306 :     {
307 :     warn "Ifconfig not found\n";
308 :     return "localhost";
309 :     }
310 : olson 1.11 # print "Foudn $ifconfig\n";
311 : olson 1.10
312 :     if (!open($fh, "$ifconfig $interface_name |"))
313 :     {
314 :     warn "Could not run $ifconfig: $!\n";
315 :     return "localhost";
316 :     }
317 :    
318 :     my $ip;
319 :     while (<$fh>)
320 :     {
321 :     #
322 :     # Mac:
323 :     # inet 140.221.10.153 netmask 0xfffffc00 broadcast 140.221.11.255
324 :     # Linux:
325 :     # inet addr:140.221.34.37 Bcast:140.221.34.63 Mask:255.255.255.224
326 :     #
327 :    
328 :     chomp;
329 :     s/^\s*//;
330 :    
331 : olson 1.11 # print "Have '$_'\n";
332 : olson 1.10 if (/inet\s+addr:(\d+\.\d+\.\d+\.\d+)\s+/)
333 :     {
334 :     #
335 :     # Linux hit.
336 :     #
337 :     $ip = $1;
338 : olson 1.11 # print "Got linux $ip\n";
339 : olson 1.10 last;
340 :     }
341 :     elsif (/inet\s+(\d+\.\d+\.\d+\.\d+)\s+/)
342 :     {
343 :     #
344 :     # Mac hit.
345 :     #
346 :     $ip = $1;
347 : olson 1.11 # print "Got mac $ip\n";
348 : olson 1.10 last;
349 :     }
350 :     }
351 :     close($fh);
352 :    
353 :     if ($ip eq "")
354 :     {
355 :     warn "Didn't find an IP\n";
356 :     return "localhost";
357 :     }
358 :    
359 :     return $ip;
360 : efrank 1.1 }
361 :    
362 : olson 1.38 sub get_seed_id {
363 :     #
364 :     # Retrieve the seed identifer from FIGdisk/config/seed_id.
365 :     #
366 :     # If it's not there, create one, and make it readonly.
367 :     #
368 :    
369 :     my $id;
370 :     my $id_file = "$FIG_Config::fig_disk/config/seed_id";
371 :     if (! -f $id_file)
372 :     {
373 :     my $newid = `uuidgen`;
374 :     if (!$newid)
375 :     {
376 :     die "Cannot run uuidgen: $!";
377 :     }
378 :    
379 :     chomp($newid);
380 :     my $fh = new FileHandle(">$id_file");
381 :     if (!$fh)
382 :     {
383 :     die "error creating $id_file: $!";
384 :     }
385 :     print $fh "$newid\n";
386 :     $fh->close();
387 :     chmod(0444, $id_file);
388 :     }
389 :     my $fh = new FileHandle("<$id_file");
390 :     $id = <$fh>;
391 :     chomp($id);
392 :     return $id;
393 :     }
394 :    
395 : efrank 1.1 sub cgi_url {
396 :     return &plug_url($FIG_Config::cgi_url);
397 :     }
398 :    
399 :     sub temp_url {
400 :     return &plug_url($FIG_Config::temp_url);
401 :     }
402 :    
403 :     sub plug_url {
404 :     my($url) = @_;
405 :    
406 : golsen 1.44 my $name;
407 :    
408 :     # Revised by GJO
409 :     # First try to get url from the current http request
410 :    
411 :     if ( defined( $ENV{ 'HTTP_HOST' } ) # This is where $cgi->url gets its value
412 :     && ( $name = $ENV{ 'HTTP_HOST' } )
413 :     && ( $url =~ s~^http://[^/]*~http://$name~ ) # ~ is delimiter
414 :     ) {}
415 :    
416 :     # Otherwise resort to alternative sources
417 :    
418 :     elsif ( ( $name = &get_local_hostname )
419 :     && ( $url =~ s~^http://[^/]*~http://$name~ ) # ~ is delimiter
420 :     ) {}
421 :    
422 : efrank 1.1 return $url;
423 :     }
424 :    
425 :     =pod
426 :    
427 :     =head1 hiding/caching in a FIG object
428 :    
429 :     We save the DB handle, cache taxonomies, and put a few other odds and ends in the
430 :     FIG object. We expect users to invoke these services using the object $fig constructed
431 :     using:
432 :    
433 :     use FIG;
434 :     my $fig = new FIG;
435 :    
436 :     $fig is then used as the basic mechanism for accessing FIG services. It is, of course,
437 :     just a hash that is used to retain/cache data. The most commonly accessed item is the
438 :     DB filehandle, which is accessed via $self->db_handle.
439 :    
440 :     We cache genus/species expansions, taxonomies, distances (very crudely estimated) estimated
441 :     between genomes, and a variety of other things. I am not sure that using cached/2 was a
442 :     good idea, but I did it.
443 :    
444 :     =cut
445 :    
446 :     sub db_handle {
447 :     my($self) = @_;
448 :    
449 :     return $self->{_dbf};
450 :     }
451 :    
452 :     sub cached {
453 :     my($self,$what) = @_;
454 :    
455 :     my $x = $self->{$what};
456 :     if (! $x)
457 :     {
458 :     $x = $self->{$what} = {};
459 :     }
460 :     return $x;
461 :     }
462 :    
463 :     ################ Basic Routines [ existed since WIT ] ##########################
464 :    
465 :    
466 :     =pod
467 :    
468 :     =head1 min
469 :    
470 :     usage: $n = &FIG::min(@x)
471 :    
472 :     Assumes @x contains numeric values. Returns the minimum of the values.
473 :    
474 :     =cut
475 :    
476 :     sub min {
477 :     my(@x) = @_;
478 :     my($min,$i);
479 :    
480 :     (@x > 0) || return undef;
481 :     $min = $x[0];
482 :     for ($i=1; ($i < @x); $i++)
483 :     {
484 :     $min = ($min > $x[$i]) ? $x[$i] : $min;
485 :     }
486 :     return $min;
487 :     }
488 :    
489 :     =pod
490 :    
491 :     =head1 max
492 :    
493 :     usage: $n = &FIG::max(@x)
494 :    
495 :     Assumes @x contains numeric values. Returns the maximum of the values.
496 :    
497 :     =cut
498 :    
499 :     sub max {
500 :     my(@x) = @_;
501 :     my($max,$i);
502 :    
503 :     (@x > 0) || return undef;
504 :     $max = $x[0];
505 :     for ($i=1; ($i < @x); $i++)
506 :     {
507 :     $max = ($max < $x[$i]) ? $x[$i] : $max;
508 :     }
509 :     return $max;
510 :     }
511 :    
512 :     =pod
513 :    
514 :     =head1 between
515 :    
516 :     usage: &FIG::between($x,$y,$z)
517 :    
518 :     Returns true iff $y is between $x and $z.
519 :    
520 :     =cut
521 :    
522 :     sub between {
523 :     my($x,$y,$z) = @_;
524 :    
525 :     if ($x < $z)
526 :     {
527 :     return (($x <= $y) && ($y <= $z));
528 :     }
529 :     else
530 :     {
531 :     return (($x >= $y) && ($y >= $z));
532 :     }
533 :     }
534 :    
535 :     =pod
536 :    
537 :     =head1 standard_genetic_code
538 :    
539 :     usage: $code = &FIG::standard_genetic_code()
540 :    
541 :     Routines like "translate" can take a "genetic code" as an argument. I implemented such
542 :     codes using hashes that assumed uppercase DNA triplets as keys.
543 :    
544 :     =cut
545 :    
546 :     sub standard_genetic_code {
547 :    
548 :     my $code = {};
549 :    
550 :     $code->{"AAA"} = "K";
551 :     $code->{"AAC"} = "N";
552 :     $code->{"AAG"} = "K";
553 :     $code->{"AAT"} = "N";
554 :     $code->{"ACA"} = "T";
555 :     $code->{"ACC"} = "T";
556 :     $code->{"ACG"} = "T";
557 :     $code->{"ACT"} = "T";
558 :     $code->{"AGA"} = "R";
559 :     $code->{"AGC"} = "S";
560 :     $code->{"AGG"} = "R";
561 :     $code->{"AGT"} = "S";
562 :     $code->{"ATA"} = "I";
563 :     $code->{"ATC"} = "I";
564 :     $code->{"ATG"} = "M";
565 :     $code->{"ATT"} = "I";
566 :     $code->{"CAA"} = "Q";
567 :     $code->{"CAC"} = "H";
568 :     $code->{"CAG"} = "Q";
569 :     $code->{"CAT"} = "H";
570 :     $code->{"CCA"} = "P";
571 :     $code->{"CCC"} = "P";
572 :     $code->{"CCG"} = "P";
573 :     $code->{"CCT"} = "P";
574 :     $code->{"CGA"} = "R";
575 :     $code->{"CGC"} = "R";
576 :     $code->{"CGG"} = "R";
577 :     $code->{"CGT"} = "R";
578 :     $code->{"CTA"} = "L";
579 :     $code->{"CTC"} = "L";
580 :     $code->{"CTG"} = "L";
581 :     $code->{"CTT"} = "L";
582 :     $code->{"GAA"} = "E";
583 :     $code->{"GAC"} = "D";
584 :     $code->{"GAG"} = "E";
585 :     $code->{"GAT"} = "D";
586 :     $code->{"GCA"} = "A";
587 :     $code->{"GCC"} = "A";
588 :     $code->{"GCG"} = "A";
589 :     $code->{"GCT"} = "A";
590 :     $code->{"GGA"} = "G";
591 :     $code->{"GGC"} = "G";
592 :     $code->{"GGG"} = "G";
593 :     $code->{"GGT"} = "G";
594 :     $code->{"GTA"} = "V";
595 :     $code->{"GTC"} = "V";
596 :     $code->{"GTG"} = "V";
597 :     $code->{"GTT"} = "V";
598 :     $code->{"TAA"} = "*";
599 :     $code->{"TAC"} = "Y";
600 :     $code->{"TAG"} = "*";
601 :     $code->{"TAT"} = "Y";
602 :     $code->{"TCA"} = "S";
603 :     $code->{"TCC"} = "S";
604 :     $code->{"TCG"} = "S";
605 :     $code->{"TCT"} = "S";
606 :     $code->{"TGA"} = "*";
607 :     $code->{"TGC"} = "C";
608 :     $code->{"TGG"} = "W";
609 :     $code->{"TGT"} = "C";
610 :     $code->{"TTA"} = "L";
611 :     $code->{"TTC"} = "F";
612 :     $code->{"TTG"} = "L";
613 :     $code->{"TTT"} = "F";
614 :    
615 :     return $code;
616 :     }
617 :    
618 :     =pod
619 :    
620 :     =head1 translate
621 :    
622 :     usage: $aa_seq = &FIG::translate($dna_seq,$code,$fix_start);
623 :    
624 :     If $code is undefined, I use the standard genetic code. If $fix_start is true, I
625 :     will translate initial TTG or GTG to 'M'.
626 :    
627 :     =cut
628 :    
629 :     sub translate {
630 :     my( $dna,$code,$start) = @_;
631 :     my( $i,$j,$ln );
632 :     my( $x,$y );
633 :     my( $prot );
634 :    
635 :     if (! defined($code))
636 :     {
637 :     $code = &FIG::standard_genetic_code;
638 :     }
639 :     $ln = length($dna);
640 :     $prot = "X" x ($ln/3);
641 :     $dna =~ tr/a-z/A-Z/;
642 :    
643 :     for ($i=0,$j=0; ($i < ($ln-2)); $i += 3,$j++)
644 :     {
645 :     $x = substr($dna,$i,3);
646 :     if ($y = $code->{$x})
647 :     {
648 :     substr($prot,$j,1) = $y;
649 :     }
650 :     }
651 :    
652 :     if (($start) && ($ln >= 3) && (substr($dna,0,3) =~ /^[GT]TG$/))
653 :     {
654 :     substr($prot,0,1) = 'M';
655 :     }
656 :     return $prot;
657 :     }
658 :    
659 :     =pod
660 :    
661 :     =head1 reverse_comp and rev_comp
662 :    
663 :     usage: $dnaR = &FIG::reverse_comp($dna) or
664 :     $dnaRP = &FIG::rev_comp($seqP)
665 :    
666 :     In WIT, we implemented reverse complement passing a pointer to a sequence and returning
667 :     a pointer to a sequence. In most cases the pointers are a pain (although in a few they
668 :     are just what is needed). Hence, I kept both versions of the function to allow you
669 :     to use whichever you like. Use rev_comp only for long strings where passing pointers is a
670 :     reasonable effeciency issue.
671 :    
672 :     =cut
673 :    
674 :     sub reverse_comp {
675 :     my($seq) = @_;
676 :    
677 :     return ${&rev_comp(\$seq)};
678 :     }
679 :    
680 :     sub rev_comp {
681 :     my( $seqP ) = @_;
682 :     my( $rev );
683 :    
684 :     $rev = reverse( $$seqP );
685 :     $rev =~ tr/a-z/A-Z/;
686 :     $rev =~ tr/ACGTUMRWSYKBDHV/TGCAAKYWSRMVHDB/;
687 :     return \$rev;
688 :     }
689 :    
690 :     =pod
691 :    
692 :     =head1 verify_dir
693 :    
694 :     usage: &FIG::verify_dir($dir)
695 :    
696 :     Makes sure that $dir exists. If it has to create it, it sets permissions to 0777.
697 :    
698 :     =cut
699 :    
700 :     sub verify_dir {
701 :     my($dir) = @_;
702 :    
703 :     if (-d $dir) { return }
704 :     if ($dir =~ /^(.*)\/[^\/]+$/)
705 :     {
706 :     &verify_dir($1);
707 :     }
708 :     mkdir($dir,0777) || die "could not make $dir";
709 : disz 1.60 chmod 02777,$dir;
710 : efrank 1.1 }
711 :    
712 :     =pod
713 :    
714 :     =head1 run
715 :    
716 :     usage: &FIG::run($cmd)
717 :    
718 :     Runs $cmd and fails (with trace) if the command fails.
719 :    
720 :     =cut
721 :    
722 : mkubal 1.53
723 : efrank 1.1 sub run {
724 :     my($cmd) = @_;
725 :    
726 : golsen 1.44 # my @tmp = `date`; chomp @tmp; print STDERR "$tmp[0]: running $cmd\n";
727 : efrank 1.1 (system($cmd) == 0) || confess "FAILED: $cmd";
728 :     }
729 :    
730 : gdpusch 1.45
731 :    
732 :     =pod
733 :    
734 :     =head1 read_fasta_record(\*FILEHANDLE)
735 :    
736 :     Usage: ( $seq_id, $sequence, $comment ) = &read_fasta_record(\*FILEHANDLE);
737 :    
738 :     Function: Reads a FASTA-formatted sequence file one record at a time.
739 :     The input filehandle defaults to STDIN if not specified.
740 :     Returns a sequence ID, a pointer to the sequence, and an optional
741 :     record comment (NOTE: Record comments are deprecated, as some tools
742 :     such as BLAST do not handle them gracefully). Returns an empty list
743 :     if attempting to read a record results in an undefined value
744 :     (e.g., due to reaching the EOF).
745 :    
746 :     Author: Gordon D. Pusch
747 :    
748 :     Date: 2004-Feb-18
749 :    
750 :     =cut
751 :    
752 :     sub read_fasta_record
753 :     {
754 :     my ($file_handle) = @_;
755 : gdpusch 1.46 my ( $old_end_of_record, $fasta_record, @lines, $head, $sequence, $seq_id, $comment, @parsed_fasta_record );
756 : gdpusch 1.45
757 :     if (not defined($file_handle)) { $file_handle = \*STDIN; }
758 :    
759 :     $old_end_of_record = $/;
760 :     $/ = "\n>";
761 :    
762 :     if (defined($fasta_record = <$file_handle>))
763 :     {
764 :     chomp $fasta_record;
765 :     @lines = split( /\n/, $fasta_record );
766 :     $head = shift @lines;
767 :     $head =~ s/^>?//;
768 :     $head =~ m/^(\S+)/;
769 :     $seq_id = $1;
770 :    
771 :     if ($head =~ m/^\S+\s+(.*)$/) { $comment = $1; } else { $comment = ""; }
772 :    
773 :     $sequence = join( "", @lines );
774 :    
775 :     @parsed_fasta_record = ( $seq_id, \$sequence, $comment );
776 :     }
777 :     else
778 :     {
779 :     @parsed_fasta_record = ();
780 :     }
781 :    
782 :     $/ = $old_end_of_record;
783 :    
784 :     return @parsed_fasta_record;
785 :     }
786 :    
787 :    
788 : efrank 1.1 =pod
789 :    
790 :     =head1 display_id_and_seq
791 :    
792 :     usage: &FIG::display_id_and_seq($id_and_comment,$seqP,$fh)
793 :    
794 :     This command has always been used to put out fasta sequences. Note that it
795 :     takes a pointer to the sequence. $fh is optional and defalts to STDOUT.
796 :    
797 :     =cut
798 :    
799 : mkubal 1.53
800 : efrank 1.1 sub display_id_and_seq {
801 :     my( $id, $seq, $fh ) = @_;
802 :    
803 :     if (! defined($fh) ) { $fh = \*STDOUT; }
804 :    
805 :     print $fh ">$id\n";
806 :     &display_seq($seq, $fh);
807 :     }
808 :    
809 :     sub display_seq {
810 :     my ( $seq, $fh ) = @_;
811 :     my ( $i, $n, $ln );
812 :    
813 :     if (! defined($fh) ) { $fh = \*STDOUT; }
814 :    
815 :     $n = length($$seq);
816 :     # confess "zero-length sequence ???" if ( (! defined($n)) || ($n == 0) );
817 :     for ($i=0; ($i < $n); $i += 60)
818 :     {
819 :     if (($i + 60) <= $n)
820 :     {
821 :     $ln = substr($$seq,$i,60);
822 :     }
823 :     else
824 :     {
825 :     $ln = substr($$seq,$i,($n-$i));
826 :     }
827 :     print $fh "$ln\n";
828 :     }
829 :     }
830 :    
831 :     ########## I commented the pods on the following routines out, since they should not
832 :     ########## be part of the SOAP/WSTL interface
833 :     #=pod
834 :     #
835 :     #=head1 file2N
836 :     #
837 :     #usage: $n = $fig->file2N($file)
838 :     #
839 :     #In some of the databases I need to store filenames, which can waste a lot of
840 :     #space. Hence, I maintain a database for converting filenames to/from integers.
841 :     #
842 :     #=cut
843 :     #
844 :     sub file2N {
845 :     my($self,$file) = @_;
846 :     my($relational_db_response);
847 :    
848 :     my $rdbH = $self->db_handle;
849 :    
850 :     if (($relational_db_response = $rdbH->SQL("SELECT fileno FROM file_table WHERE ( file = \'$file\')")) &&
851 :     (@$relational_db_response == 1))
852 :     {
853 :     return $relational_db_response->[0]->[0];
854 :     }
855 :     elsif (($relational_db_response = $rdbH->SQL("SELECT MAX(fileno) FROM file_table ")) && (@$relational_db_response == 1) && ($relational_db_response->[0]->[0]))
856 :     {
857 :     my $fileno = $relational_db_response->[0]->[0] + 1;
858 :     if ($rdbH->SQL("INSERT INTO file_table ( file, fileno ) VALUES ( \'$file\', $fileno )"))
859 :     {
860 :     return $fileno;
861 :     }
862 :     }
863 :     elsif ($rdbH->SQL("INSERT INTO file_table ( file, fileno ) VALUES ( \'$file\', 1 )"))
864 :     {
865 :     return 1;
866 :     }
867 :     return undef;
868 :     }
869 :    
870 :     #=pod
871 :     #
872 :     #=head1 N2file
873 :     #
874 :     #usage: $filename = $fig->N2file($n)
875 :     #
876 :     #In some of the databases I need to store filenames, which can waste a lot of
877 :     #space. Hence, I maintain a database for converting filenames to/from integers.
878 :     #
879 :     #=cut
880 :     #
881 :     sub N2file {
882 :     my($self,$fileno) = @_;
883 :     my($relational_db_response);
884 :    
885 :     my $rdbH = $self->db_handle;
886 :    
887 :     if (($relational_db_response = $rdbH->SQL("SELECT file FROM file_table WHERE ( fileno = $fileno )")) &&
888 :     (@$relational_db_response == 1))
889 :     {
890 :     return $relational_db_response->[0]->[0];
891 :     }
892 :     return undef;
893 :     }
894 :    
895 :    
896 :     #=pod
897 :     #
898 :     #=head1 openF
899 :     #
900 :     #usage: $fig->openF($filename)
901 :     #
902 :     #Parts of the system rely on accessing numerous different files. The most obvious case is
903 :     #the situation with similarities. It is important that the system be able to run in cases in
904 :     #which an arbitrary number of files cannot be open simultaneously. This routine (with closeF) is
905 :     #a hack to handle this. I should probably just pitch them and insist that the OS handle several
906 :     #hundred open filehandles.
907 :     #
908 :     #=cut
909 :     #
910 :     sub openF {
911 :     my($self,$file) = @_;
912 :     my($fxs,$x,@fxs,$fh);
913 :    
914 :     $fxs = $self->cached('_openF');
915 :     if ($x = $fxs->{$file})
916 :     {
917 :     $x->[1] = time();
918 :     return $x->[0];
919 :     }
920 :    
921 :     @fxs = keys(%$fxs);
922 :     if (defined($fh = new FileHandle "<$file"))
923 :     {
924 :     if (@fxs >= 200)
925 :     {
926 :     @fxs = sort { $fxs->{$a}->[1] <=> $fxs->{$b}->[1] } @fxs;
927 :     $x = $fxs->{$fxs[0]};
928 :     undef $x->[0];
929 :     delete $fxs->{$fxs[0]};
930 :     }
931 :     $fxs->{$file} = [$fh,time()];
932 :     return $fh;
933 :     }
934 :     return undef;
935 :     }
936 :    
937 :     #=pod
938 :     #
939 :     #=head1 closeF
940 :     #
941 :     #usage: $fig->closeF($filename)
942 :     #
943 :     #Parts of the system rely on accessing numerous different files. The most obvious case is
944 :     #the situation with similarities. It is important that the system be able to run in cases in
945 :     #which an arbitrary number of files cannot be open simultaneously. This routine (with openF) is
946 :     #a hack to handle this. I should probably just pitch them and insist that the OS handle several
947 :     #hundred open filehandles.
948 :     #
949 :     #=cut
950 :     #
951 :     sub closeF {
952 :     my($self,$file) = @_;
953 :     my($fxs,$x);
954 :    
955 :     if (($fxs = $self->{_openF}) &&
956 :     ($x = $fxs->{$file}))
957 :     {
958 :     undef $x->[0];
959 :     delete $fxs->{$file};
960 :     }
961 :     }
962 :    
963 :     =pod
964 :    
965 :     =head1 ec_name
966 :    
967 :     usage: $enzymatic_function = $fig->ec_name($ec)
968 :    
969 :     Returns enzymatic name for EC.
970 :    
971 :     =cut
972 :    
973 :     sub ec_name {
974 :     my($self,$ec) = @_;
975 :    
976 :     ($ec =~ /^\d+\.\d+\.\d+\.\d+$/) || return "";
977 :     my $rdbH = $self->db_handle;
978 :     my $relational_db_response = $rdbH->SQL("SELECT name FROM ec_names WHERE ( ec = \'$ec\' )");
979 :    
980 :     return (@$relational_db_response == 1) ? $relational_db_response->[0]->[0] : "";
981 :     return "";
982 :     }
983 :    
984 :     =pod
985 :    
986 :     =head1 all_roles
987 :    
988 :     usage: @roles = $fig->all_roles
989 :    
990 : mkubal 1.54 Supposed to return all known roles. For now, we get all ECs with "names".
991 : efrank 1.1
992 :     =cut
993 :    
994 :     sub all_roles {
995 :     my($self) = @_;
996 :    
997 :     my $rdbH = $self->db_handle;
998 :     my $relational_db_response = $rdbH->SQL("SELECT ec,name FROM ec_names");
999 :    
1000 :     return @$relational_db_response;
1001 :     }
1002 :    
1003 :     =pod
1004 :    
1005 :     =head1 expand_ec
1006 :    
1007 :     usage: $expanded_ec = $fig->expand_ec($ec)
1008 :    
1009 :     Expands "1.1.1.1" to "1.1.1.1 - alcohol dehydrogenase" or something like that.
1010 :    
1011 :     =cut
1012 :    
1013 :     sub expand_ec {
1014 :     my($self,$ec) = @_;
1015 :     my($name);
1016 :    
1017 :     return ($name = $self->ec_name($ec)) ? "$ec - $name" : $ec;
1018 :     }
1019 :    
1020 :    
1021 :     =pod
1022 :    
1023 :     =head1 clean_tmp
1024 :    
1025 :     usage: &FIG::clean_tmp
1026 :    
1027 :     We store temporary files in $FIG_Config::temp. There are specific classes of files
1028 :     that are created and should be saved for at least a few days. This routine can be
1029 :     invoked to clean out those that are over two days old.
1030 :    
1031 :     =cut
1032 :    
1033 :     sub clean_tmp {
1034 :    
1035 :     my($file);
1036 :     if (opendir(TMP,"$FIG_Config::temp"))
1037 :     {
1038 :     # change the pattern to pick up other files that need to be cleaned up
1039 :     my @temp = grep { $_ =~ /^(Geno|tmp)/ } readdir(TMP);
1040 :     foreach $file (@temp)
1041 :     {
1042 :     if (-M "$FIG_Config::temp/$file" > 2)
1043 :     {
1044 :     unlink("$FIG_Config::temp/$file");
1045 :     }
1046 :     }
1047 :     }
1048 :     }
1049 :    
1050 :     ################ Routines to process genomes and genome IDs ##########################
1051 :    
1052 :    
1053 :     =pod
1054 :    
1055 :     =head1 genomes
1056 :    
1057 :     usage: @genome_ids = $fig->genomes;
1058 :    
1059 :     Genomes are assigned ids of the form X.Y where X is the taxonomic id maintained by
1060 :     NCBI for the species (not the specific strain), and Y is a sequence digit assigned to
1061 :     this particular genome (as one of a set with the same genus/species). Genomes also
1062 :     have versions, but that is a separate issue.
1063 :    
1064 :     =cut
1065 :    
1066 :     sub genomes {
1067 : overbeek 1.13 my($self,$complete,$restrictions) = @_;
1068 :    
1069 :     my $rdbH = $self->db_handle;
1070 :    
1071 :     my @where = ();
1072 :     if ($complete)
1073 :     {
1074 :     push(@where,"( complete = \'1\' )")
1075 :     }
1076 :    
1077 :     if ($restrictions)
1078 :     {
1079 :     push(@where,"( restrictions = \'1\' )")
1080 :     }
1081 :    
1082 :     my $relational_db_response;
1083 :     if (@where > 0)
1084 :     {
1085 :     my $where = join(" AND ",@where);
1086 :     $relational_db_response = $rdbH->SQL("SELECT genome FROM genome where $where");
1087 :     }
1088 :     else
1089 :     {
1090 :     $relational_db_response = $rdbH->SQL("SELECT genome FROM genome");
1091 :     }
1092 :     my @genomes = sort { $a <=> $b } map { $_->[0] } @$relational_db_response;
1093 : efrank 1.1 return @genomes;
1094 :     }
1095 :    
1096 : efrank 1.2 sub genome_counts {
1097 : overbeek 1.13 my($self,$complete) = @_;
1098 :     my($x,$relational_db_response);
1099 : efrank 1.2
1100 : overbeek 1.13 my $rdbH = $self->db_handle;
1101 :    
1102 :     if ($complete)
1103 :     {
1104 :     $relational_db_response = $rdbH->SQL("SELECT genome,maindomain FROM genome where complete = '1'");
1105 :     }
1106 :     else
1107 :     {
1108 :     $relational_db_response = $rdbH->SQL("SELECT genome,maindomain FROM genome");
1109 :     }
1110 :    
1111 :     my ($a,$b,$e,$v) = (0,0,0,0);
1112 :     if (@$relational_db_response > 0)
1113 : efrank 1.2 {
1114 : overbeek 1.13 foreach $x (@$relational_db_response)
1115 : efrank 1.2 {
1116 : overbeek 1.13 if ($x->[1] =~ /^a/i) { $a++ }
1117 :     elsif ($x->[1] =~ /^b/i) { $b++ }
1118 :     elsif ($x->[1] =~ /^e/i) { $e++ }
1119 :     elsif ($x->[1] =~ /^v/i) { $v++ }
1120 : efrank 1.2 }
1121 :     }
1122 : overbeek 1.13
1123 : efrank 1.2 return ($a,$b,$e,$v);
1124 :     }
1125 :    
1126 : efrank 1.1 =pod
1127 :    
1128 :     =head1 genome_version
1129 :    
1130 :     usage: $version = $fig->genome_version($genome_id);
1131 :    
1132 :     Versions are incremented for major updates. They are put in as major
1133 :     updates of the form 1.0, 2.0, ...
1134 :    
1135 :     Users may do local "editing" of the DNA for a genome, but when they do,
1136 :     they increment the digits to the right of the decimal. Two genomes remain
1137 :     comparable only if the versions match identically. Hence, minor updating should be
1138 :     committed only by the person/group responsible for updating that genome.
1139 :    
1140 :     We can, of course, identify which genes are identical between any two genomes (by matching
1141 :     the DNA or amino acid sequences). However, the basic intent of the system is to
1142 :     support editing by the main group issuing periodic major updates.
1143 :    
1144 :     =cut
1145 :    
1146 :     sub genome_version {
1147 :     my($self,$genome) = @_;
1148 :    
1149 :     my(@tmp);
1150 :     if ((-s "$FIG_Config::organisms/$genome/VERSION") &&
1151 :     (@tmp = `cat $FIG_Config::organisms/$genome/VERSION`) &&
1152 :     ($tmp[0] =~ /^(\d+(\.\d+)?)$/))
1153 :     {
1154 :     return $1;
1155 :     }
1156 :     return undef;
1157 :     }
1158 :    
1159 :     =pod
1160 :    
1161 :     =head1 genus_species
1162 :    
1163 :     usage: $gs = $fig->genus_species($genome_id)
1164 :    
1165 :     Returns the genus and species (and strain if that has been properly recorded)
1166 :     in a printable form.
1167 :    
1168 :     =cut
1169 :    
1170 :     sub genus_species {
1171 :     my ($self,$genome) = @_;
1172 : overbeek 1.13 my $ans;
1173 : efrank 1.1
1174 :     my $genus_species = $self->cached('_genus_species');
1175 :     if (! ($ans = $genus_species->{$genome}))
1176 :     {
1177 : overbeek 1.13 my $rdbH = $self->db_handle;
1178 :     my $relational_db_response = $rdbH->SQL("SELECT genome,gname FROM genome");
1179 :     my $pair;
1180 :     foreach $pair (@$relational_db_response)
1181 : efrank 1.1 {
1182 : overbeek 1.13 $genus_species->{$pair->[0]} = $pair->[1];
1183 : efrank 1.1 }
1184 : overbeek 1.13 $ans = $genus_species->{$genome};
1185 : efrank 1.1 }
1186 :     return $ans;
1187 :     }
1188 :    
1189 :     =pod
1190 :    
1191 :     =head1 org_of
1192 :    
1193 :     usage: $org = $fig->org_of($prot_id)
1194 :    
1195 :     In the case of external proteins, we can usually determine an organism, but not
1196 :     anything more precise than genus/species (and often not that). This routine takes
1197 : efrank 1.2 a protein ID (which may be a feature ID) and returns "the organism".
1198 : efrank 1.1
1199 :     =cut
1200 :    
1201 :     sub org_of {
1202 :     my($self,$prot_id) = @_;
1203 :     my $relational_db_response;
1204 :     my $rdbH = $self->db_handle;
1205 :    
1206 :     if ($prot_id =~ /^fig\|/)
1207 :     {
1208 :     return $self->genus_species($self->genome_of($prot_id));
1209 :     }
1210 :    
1211 :     if (($relational_db_response = $rdbH->SQL("SELECT org FROM external_orgs WHERE ( prot = \'$prot_id\' )")) &&
1212 :     (@$relational_db_response >= 1))
1213 :     {
1214 :     return $relational_db_response->[0]->[0];
1215 :     }
1216 :     return "";
1217 :     }
1218 :    
1219 :     =pod
1220 :    
1221 :     =head1 abbrev
1222 :    
1223 :     usage: $abbreviated_name = $fig->abbrev($genome_name)
1224 :    
1225 :     For alignments and such, it is very useful to be able to produce an abbreviation of genus/species.
1226 :     That's what this does. Note that multiple genus/species might reduce to the same abbreviation, so
1227 :     be careful (disambiguate them, if you must).
1228 :    
1229 :     =cut
1230 :    
1231 :     sub abbrev {
1232 :     my($genome_name) = @_;
1233 :    
1234 :     $genome_name =~ s/^(\S{3})\S+/$1./;
1235 :     $genome_name =~ s/^(\S+\s+\S{4})\S+/$1./;
1236 :     if (length($genome_name) > 13)
1237 :     {
1238 :     $genome_name = substr($genome_name,0,13);
1239 :     }
1240 :     return $genome_name;
1241 :     }
1242 :    
1243 :     ################ Routines to process Features and Feature IDs ##########################
1244 :    
1245 :     =pod
1246 :    
1247 :     =head1 ftype
1248 :    
1249 :     usage: $type = &FIG::ftype($fid)
1250 :    
1251 :     Returns the type of a feature, given the feature ID. This just amounts
1252 :     to lifting it out of the feature ID, since features have IDs of tghe form
1253 :    
1254 :     fig|x.y.f.n
1255 :    
1256 :     where
1257 :     x.y is the genome ID
1258 :     f is the type pf feature
1259 :     n is an integer that is unique within the genome/type
1260 :    
1261 :     =cut
1262 :    
1263 :     sub ftype {
1264 :     my($feature_id) = @_;
1265 :    
1266 :     if ($feature_id =~ /^fig\|\d+\.\d+\.([^\.]+)/)
1267 :     {
1268 :     return $1;
1269 :     }
1270 :     return undef;
1271 :     }
1272 :    
1273 :     =pod
1274 :    
1275 :     =head1 genome_of
1276 :    
1277 :     usage: $genome_id = $fig->genome_of($fid)
1278 :    
1279 :     This just extracts the genome ID from a feature ID.
1280 :    
1281 :     =cut
1282 :    
1283 :    
1284 :     sub genome_of {
1285 :     my $prot_id = (@_ == 1) ? $_[0] : $_[1];
1286 :    
1287 :     if ($prot_id =~ /^fig\|(\d+\.\d+)/) { return $1; }
1288 :     return undef;
1289 :     }
1290 :    
1291 :     =pod
1292 :    
1293 :     =head1 by_fig_id
1294 :    
1295 :     usage: @sorted_by_fig_id = sort { &FIG::by_fig_id($a,$b) } @fig_ids
1296 :    
1297 :     This is a bit of a clutzy way to sort a list of FIG feature IDs, but it works.
1298 :    
1299 :     =cut
1300 :    
1301 :     sub by_fig_id {
1302 :     my($a,$b) = @_;
1303 :     my($g1,$g2,$t1,$t2,$n1,$n2);
1304 :     if (($a =~ /^fig\|(\d+\.\d+).([^\.]+)\.(\d+)$/) && (($g1,$t1,$n1) = ($1,$2,$3)) &&
1305 :     ($b =~ /^fig\|(\d+\.\d+).([^\.]+)\.(\d+)$/) && (($g2,$t2,$n2) = ($1,$2,$3)))
1306 :     {
1307 :     ($g1 <=> $g2) or ($t1 cmp $t2) or ($n1 <=> $n2);
1308 :     }
1309 :     else
1310 :     {
1311 :     $a cmp $b;
1312 :     }
1313 :     }
1314 :    
1315 :     =pod
1316 :    
1317 :     =head1 genes_in_region
1318 :    
1319 :     usage: ($features_in_region,$beg1,$end1) = $fig->genes_in_region($genome,$contig,$beg,$end)
1320 :    
1321 :     It is often important to be able to find the genes that occur in a specific region on
1322 :     a chromosome. This routine is designed to provide this information. It returns all genes
1323 :     that overlap the region ($genome,$contig,$beg,$end). $beg1 is set to the minimum coordinate of
1324 :     the returned genes (which may be before the given region), and $end1 the maximum coordinate.
1325 :    
1326 :     The routine assumes that genes are not more than 10000 bases long, which is certainly not true
1327 :     in eukaryotes. Hence, in euks you may well miss genes that overlap the boundaries of the specified
1328 :     region (sorry).
1329 :    
1330 :     =cut
1331 :    
1332 :    
1333 :     sub genes_in_region {
1334 :     my($self,$genome,$contig,$beg,$end) = @_;
1335 :     my($x,$relational_db_response,$feature_id,$b1,$e1,@feat,@tmp,$l,$u);
1336 :    
1337 :     my $pad = 10000;
1338 :     my $rdbH = $self->db_handle;
1339 :    
1340 :     my $minV = $beg - $pad;
1341 :     my $maxV = $end + $pad;
1342 :     if (($relational_db_response = $rdbH->SQL("SELECT id FROM features
1343 :     WHERE ( minloc > $minV ) AND ( minloc < $maxV ) AND (maxloc < $maxV) AND
1344 :     ( genome = \'$genome\' ) AND ( contig = \'$contig\' );")) &&
1345 :     (@$relational_db_response >= 1))
1346 :     {
1347 :     @tmp = sort { ($a->[1] cmp $b->[1]) or
1348 :     ($a->[2] <=> $b->[2]) or
1349 :     ($a->[3] <=> $b->[3])
1350 :     }
1351 :     map { $feature_id = $_->[0];
1352 :     $x = $self->feature_location($feature_id);
1353 :     $x ? [$feature_id,&boundaries_of($x)] : ()
1354 :     } @$relational_db_response;
1355 :    
1356 :    
1357 :     ($l,$u) = (10000000000,0);
1358 :     foreach $x (@tmp)
1359 :     {
1360 :     ($feature_id,undef,$b1,$e1) = @$x;
1361 :     if (&between($beg,&min($b1,$e1),$end) || &between(&min($b1,$e1),$beg,&max($b1,$e1)))
1362 :     {
1363 :     push(@feat,$feature_id);
1364 :     $l = &min($l,&min($b1,$e1));
1365 :     $u = &max($u,&max($b1,$e1));
1366 :     }
1367 :     }
1368 :     (@feat <= 0) || return ([@feat],$l,$u);
1369 :     }
1370 :     return ([],$l,$u);
1371 :     }
1372 :    
1373 :     sub close_genes {
1374 :     my($self,$fid,$dist) = @_;
1375 :    
1376 :     my $loc = $self->feature_location($fid);
1377 :     if ($loc)
1378 :     {
1379 :     my($contig,$beg,$end) = &FIG::boundaries_of($loc);
1380 :     if ($contig && $beg && $end)
1381 :     {
1382 :     my $min = &min($beg,$end) - $dist;
1383 :     my $max = &max($beg,$end) + $dist;
1384 :     my $feat;
1385 :     ($feat,undef,undef) = $self->genes_in_region(&FIG::genome_of($fid),$contig,$min,$max);
1386 :     return @$feat;
1387 :     }
1388 :     }
1389 :     return ();
1390 :     }
1391 :    
1392 :    
1393 :     =pod
1394 :    
1395 :     =head1 feature_location
1396 :    
1397 :     usage: $loc = $fig->feature_location($fid) OR
1398 :     @loc = $fig->feature_location($fid)
1399 :    
1400 :     The location of a feature in a scalar context is
1401 :    
1402 :     contig_b1_e1,contig_b2_e2,... [one contig_b_e for each exon]
1403 :    
1404 :     In a list context it is
1405 :    
1406 :     (contig_b1_e1,contig_b2_e2,...)
1407 :    
1408 :     =cut
1409 :    
1410 :     sub feature_location {
1411 :     my($self,$feature_id) = @_;
1412 :     my($relational_db_response,$locations,$location);
1413 :    
1414 :     $locations = $self->cached('_location');
1415 :     if (! ($location = $locations->{$feature_id}))
1416 :     {
1417 :     my $rdbH = $self->db_handle;
1418 :     if (($relational_db_response = $rdbH->SQL("SELECT location FROM features WHERE ( id = \'$feature_id\' )")) &&
1419 :     (@$relational_db_response == 1))
1420 :     {
1421 :     $locations->{$feature_id} = $location = $relational_db_response->[0]->[0];
1422 :     }
1423 :     }
1424 :    
1425 :     if ($location)
1426 :     {
1427 :     return wantarray() ? split(/,/,$location) : $location;
1428 :     }
1429 :     return undef;
1430 :     }
1431 :    
1432 :     =pod
1433 :    
1434 :     =head1 boundaries_of
1435 :    
1436 :     usage: ($contig,$beg,$end) = $fig->boundaries_of($loc)
1437 :    
1438 :     The location of a feature in a scalar context is
1439 :    
1440 :     contig_b1_e1,contig_b2_e2,... [one contig_b_e for each exon]
1441 :    
1442 :     This routine takes as input such a location and reduces it to a single
1443 :     description of the entire region containing the gene.
1444 :    
1445 :     =cut
1446 :    
1447 :     sub boundaries_of {
1448 :     my($location) = (@_ == 1) ? $_[0] : $_[1];
1449 :     my($contigQ);
1450 :    
1451 :     if (defined($location))
1452 :     {
1453 :     my @exons = split(/,/,$location);
1454 :     my($contig,$beg,$end);
1455 :     if (($exons[0] =~ /^(\S+)_(\d+)_\d+$/) &&
1456 :     (($contig,$beg) = ($1,$2)) && ($contigQ = quotemeta $contig) &&
1457 :     ($exons[$#exons] =~ /^$contigQ\_\d+_(\d+)$/) &&
1458 :     ($end = $1))
1459 :     {
1460 :     return ($contig,$beg,$end);
1461 :     }
1462 :     }
1463 :     return undef;
1464 :     }
1465 :    
1466 :    
1467 :     =pod
1468 :    
1469 :     =head1 all_features
1470 :    
1471 :     usage: $fig->all_features($genome,$type)
1472 :    
1473 :     Returns a list of all feature IDs of a specified type in the designated genome. You would
1474 :     usually use just
1475 :    
1476 :     $fig->pegs_of($genome) or
1477 :     $fig->rnas_of($genome)
1478 :    
1479 :     which simply invoke this routine.
1480 :    
1481 :     =cut
1482 :    
1483 :     sub all_features {
1484 :     my($self,$genome,$type) = @_;
1485 :    
1486 :     my $rdbH = $self->db_handle;
1487 :     my $relational_db_response = $rdbH->SQL("SELECT id FROM features WHERE (genome = \'$genome\' AND (type = \'$type\'))");
1488 :    
1489 :     if (@$relational_db_response > 0)
1490 :     {
1491 :     return map { $_->[0] } @$relational_db_response;
1492 :     }
1493 :     return ();
1494 :     }
1495 :    
1496 :    
1497 :     =pod
1498 :    
1499 :     =head1 all_pegs_of
1500 :    
1501 :     usage: $fig->all_pegs_of($genome)
1502 :    
1503 :     Returns a list of all PEGs in the specified genome. Note that order is not
1504 :     specified.
1505 :    
1506 :     =cut
1507 :    
1508 :     sub pegs_of {
1509 :     my($self,$genome) = @_;
1510 :    
1511 :     return $self->all_features($genome,"peg");
1512 :     }
1513 :    
1514 :    
1515 :     =pod
1516 :    
1517 :     =head1 all_rnas_of
1518 :    
1519 :     usage: $fig->all_rnas($genome)
1520 :    
1521 :     Returns a list of all RNAs for the given genome.
1522 :    
1523 :     =cut
1524 :    
1525 :     sub rnas_of {
1526 :     my($self,$genome) = @_;
1527 :    
1528 :     return $self->all_features($genome,"rna");
1529 :     }
1530 :    
1531 :     =pod
1532 :    
1533 :     =head1 feature_aliases
1534 :    
1535 :     usage: @aliases = $fig->feature_aliases($fid) OR
1536 :     $aliases = $fig->feature_aliases($fid)
1537 :    
1538 :     Returns a list of aliases (gene IDs, arbitrary numbers assigned by authors, etc.) for the feature.
1539 :     These must come from the tbl files, so add them there if you want to see them here.
1540 :    
1541 :     In a scalar context, the aliases come back with commas separating them.
1542 :    
1543 :     =cut
1544 :    
1545 :     sub feature_aliases {
1546 :     my($self,$feature_id) = @_;
1547 :     my($rdbH,$relational_db_response,$aliases);
1548 :    
1549 :     $rdbH = $self->db_handle;
1550 :     if (($relational_db_response = $rdbH->SQL("SELECT aliases FROM features WHERE ( id = \'$feature_id\' )")) &&
1551 :     (@$relational_db_response == 1))
1552 :     {
1553 :     $aliases = $relational_db_response->[0]->[0];
1554 :     }
1555 :     return $aliases ? (wantarray ? split(/,/,$aliases) : $aliases) : undef;
1556 :     }
1557 :    
1558 :     =pod
1559 :    
1560 : overbeek 1.34 =head1 by_alias
1561 :    
1562 :     usage: $peg = $fig->by_alias($alias)
1563 :    
1564 :     Returns a FIG id if the alias can be converted. Right now we convert aliases
1565 :     of the form NP_* (RefSeq IDs) or gi|* (GenBank IDs)
1566 :    
1567 :     =cut
1568 :    
1569 :     sub by_alias {
1570 :     my($self,$alias) = @_;
1571 :     my($rdbH,$relational_db_response,$peg);
1572 :    
1573 :     $peg = "";
1574 :     $rdbH = $self->db_handle;
1575 :     if (($relational_db_response = $rdbH->SQL("SELECT id FROM ext_alias WHERE ( alias = \'$alias\' )")) &&
1576 :     (@$relational_db_response == 1))
1577 :     {
1578 :     $peg = $relational_db_response->[0]->[0];
1579 :     }
1580 :     return $peg;
1581 :     }
1582 :    
1583 :     =pod
1584 :    
1585 : efrank 1.1 =head1 possibly_truncated
1586 :    
1587 :     usage: $fig->possibly_truncated($fid)
1588 :    
1589 :     Returns true iff the feature occurs near the end of a contig.
1590 :    
1591 :     =cut
1592 :    
1593 :     sub possibly_truncated {
1594 :     my($self,$feature_id) = @_;
1595 :     my($loc);
1596 :    
1597 :     if ($loc = $self->feature_location($feature_id))
1598 :     {
1599 :     my $genome = &genome_of($feature_id);
1600 :     my ($contig,$beg,$end) = &boundaries_of($loc);
1601 :     if ((! $self->near_end($genome,$contig,$beg)) && (! $self->near_end($genome,$contig,$end)))
1602 :     {
1603 :     return 0;
1604 :     }
1605 :     }
1606 :     return 1;
1607 :     }
1608 :    
1609 :     sub near_end {
1610 :     my($self,$genome,$contig,$x) = @_;
1611 :    
1612 :     return (($x < 300) || ($x > ($self->contig_ln($genome,$contig) - 300)));
1613 :     }
1614 :    
1615 : overbeek 1.27 sub is_real_feature {
1616 :     my($self,$fid) = @_;
1617 :     my($relational_db_response);
1618 :    
1619 :     my $rdbH = $self->db_handle;
1620 :     return (($relational_db_response = $rdbH->SQL("SELECT id FROM features WHERE ( id = \'$fid\' )")) &&
1621 : mkubal 1.53 (@$relational_db_response == 1)) ? 1 : 0;
1622 : overbeek 1.27 }
1623 :    
1624 : efrank 1.1 ################ Routines to process functional coupling for PEGs ##########################
1625 :    
1626 :     =pod
1627 :    
1628 :     =head1 coupling_and_evidence
1629 :    
1630 :     usage: @coupling_data = $fig->coupling_and_evidence($fid,$bound,$sim_cutoff,$coupling_cutoff,$keep_record)
1631 :    
1632 :     A computation of couplings and evidence starts with a given peg and produces a list of
1633 :     3-tuples. Each 3-tuple is of the form
1634 :    
1635 :     [Score,CoupledToFID,Evidence]
1636 :    
1637 :     Evidence is a list of 2-tuples of FIDs that are close in other genomes (producing
1638 :     a "pair of close homologs" of [$peg,CoupledToFID]). The maximum score for a single
1639 :     PCH is 1, but "Score" is the sum of the scores for the entire set of PCHs.
1640 :    
1641 :     If $keep_record is true, the system records the information, asserting coupling for each
1642 :     of the pairs in the set of evidence, and asserting a pin from the given $fd through all
1643 :     of the PCH entries used in forming the score.
1644 :    
1645 :     =cut
1646 :    
1647 :     sub coupling_and_evidence {
1648 :     my($self,$feature_id,$bound,$sim_cutoff,$coupling_cutoff,$keep_record) = @_;
1649 :     my($neighbors,$neigh,$similar1,$similar2,@hits,$sc,$ev,$genome1);
1650 :    
1651 :     if ($feature_id =~ /^fig\|(\d+\.\d+)/)
1652 :     {
1653 :     $genome1 = $1;
1654 :     }
1655 :    
1656 :     my($contig,$beg,$end) = &FIG::boundaries_of($self->feature_location($feature_id));
1657 :     if (! $contig) { return () }
1658 :    
1659 :     ($neighbors,undef,undef) = $self->genes_in_region(&genome_of($feature_id),
1660 :     $contig,
1661 :     &min($beg,$end) - $bound,
1662 :     &max($beg,$end) + $bound);
1663 :     if (@$neighbors == 0) { return () }
1664 :     $similar1 = $self->acceptably_close($feature_id,$sim_cutoff);
1665 :     @hits = ();
1666 :    
1667 :     foreach $neigh (grep { $_ =~ /peg/ } @$neighbors)
1668 :     {
1669 :     next if ($neigh eq $feature_id);
1670 :     $similar2 = $self->acceptably_close($neigh,$sim_cutoff);
1671 :     ($sc,$ev) = $self->coupling_ev($genome1,$similar1,$similar2,$bound);
1672 :     if ($sc >= $coupling_cutoff)
1673 :     {
1674 :     push(@hits,[$sc,$neigh,$ev]);
1675 :     }
1676 :     }
1677 :     if ($keep_record)
1678 :     {
1679 :     $self->add_chr_clusters_and_pins($feature_id,\@hits);
1680 :     }
1681 :     return sort { $b->[0] <=> $a->[0] } @hits;
1682 :     }
1683 :    
1684 : overbeek 1.35 sub fast_coupling {
1685 :     my($self,$peg,$bound,$coupling_cutoff) = @_;
1686 :     my($genome,$genome1,$genome2,$peg1,$peg2,$peg3,%maps,$loc,$loc1,$loc2,$loc3);
1687 :     my($pairs,$sc,%ev);
1688 :    
1689 :     my @ans = ();
1690 :    
1691 :     $genome = &genome_of($peg);
1692 :     foreach $peg1 ($self->in_pch_pin_with($peg))
1693 :     {
1694 :     $peg1 =~ s/,.*$//;
1695 :     if ($peg ne $peg1)
1696 :     {
1697 :     $genome1 = &genome_of($peg1);
1698 :     $maps{$peg}->{$genome1} = $peg1;
1699 :     }
1700 :     }
1701 :    
1702 :     $loc = [&boundaries_of(scalar $self->feature_location($peg))];
1703 :     foreach $peg1 ($self->in_cluster_with($peg))
1704 :     {
1705 :     if ($peg ne $peg1)
1706 :     {
1707 :     # print STDERR "peg1=$peg1\n";
1708 :     $loc1 = [&boundaries_of(scalar $self->feature_location($peg1))];
1709 :     if (&close_enough($loc,$loc1,$bound))
1710 :     {
1711 :     foreach $peg2 ($self->in_pch_pin_with($peg1))
1712 :     {
1713 :     $genome2 = &genome_of($peg2);
1714 :     if (($peg3 = $maps{$peg}->{$genome2}) && ($peg2 ne $peg3))
1715 :     {
1716 :     $loc2 = [&boundaries_of(scalar $self->feature_location($peg2))];
1717 :     $loc3 = [&boundaries_of(scalar $self->feature_location($peg3))];
1718 :     if (&close_enough($loc2,$loc3,$bound))
1719 :     {
1720 :     push(@{$ev{$peg1}},[$peg3,$peg2]);
1721 :     }
1722 :     }
1723 :     }
1724 :     }
1725 :     }
1726 :     }
1727 :     foreach $peg1 (keys(%ev))
1728 :     {
1729 :     $pairs = $ev{$peg1};
1730 : overbeek 1.43 $sc = $self->score([$peg,map { $_->[0] } @$pairs]);
1731 : overbeek 1.35 if ($sc >= $coupling_cutoff)
1732 :     {
1733 :     push(@ans,[$sc,$peg1]);
1734 :     }
1735 :     }
1736 :     return sort { $b->[0] <=> $a->[0] } @ans;
1737 :     }
1738 :    
1739 :    
1740 :     sub score {
1741 : overbeek 1.43 my($self,$pegs) = @_;
1742 : overbeek 1.51 my(@ids);
1743 : overbeek 1.35
1744 : overbeek 1.51 if ($self->{_no9s_scoring})
1745 :     {
1746 :     @ids = map { $self->maps_to_id($_) } grep { $_ !~ /^fig\|999999/ } @$pegs;
1747 :     }
1748 :     else
1749 :     {
1750 :     @ids = map { $self->maps_to_id($_) } @$pegs;
1751 :     }
1752 : overbeek 1.43 return &score1($self,\@ids) - 1;
1753 :     }
1754 :    
1755 :     sub score1 {
1756 :     my($self,$pegs) = @_;
1757 :     my($sim);
1758 :     my($first,@rest) = @$pegs;
1759 :     my $count = 1;
1760 :     my %hits = map { $_ => 1 } @rest;
1761 :     my @ordered = sort { $b->[0] <=> $a->[0] }
1762 :     map { $sim = $_; [$sim->iden,$sim->id2] }
1763 :     grep { $hits{$_->id2} }
1764 :     $self->sims($first,1000,1,"raw");
1765 : overbeek 1.76 my %ordered = map { $_->[1] => 1 } @ordered;
1766 :     foreach $_ (@rest)
1767 :     {
1768 :     if (! $ordered{$_})
1769 :     {
1770 :     push(@ordered,[0,$_]);
1771 :     }
1772 :     }
1773 :    
1774 : overbeek 1.43 while ((@ordered > 0) && ($ordered[0]->[0] >= 97))
1775 : overbeek 1.35 {
1776 : overbeek 1.43 shift @ordered ;
1777 :     }
1778 :     while (@ordered > 0)
1779 :     {
1780 :     my $start = $ordered[0]->[0];
1781 :     $_ = shift @ordered;
1782 :     my @sub = ( $_->[1] );
1783 :     while ((@ordered > 0) && ($ordered[0]->[0] > ($start-3)))
1784 : overbeek 1.35 {
1785 : overbeek 1.43 $_ = shift @ordered;
1786 :     push(@sub, $_->[1]);
1787 : overbeek 1.35 }
1788 :    
1789 : overbeek 1.43 if (@sub == 1)
1790 :     {
1791 :     $count++;
1792 :     }
1793 :     else
1794 :     {
1795 :     $count += &score1($self,\@sub);
1796 :     }
1797 : overbeek 1.35 }
1798 : overbeek 1.43 return $count;
1799 : overbeek 1.35 }
1800 :    
1801 : efrank 1.1 =pod
1802 :    
1803 :     =head1 add_chr_clusters_and_pins
1804 :    
1805 :     usage: $fig->add_chr_clusters_and_pins($peg,$hits)
1806 :    
1807 :     The system supports retaining data relating to functional coupling. If a user
1808 :     computes evidence once and then saves it with this routine, data relating to
1809 :     both "the pin" and the "clusters" (in all of the organisms supporting the
1810 :     functional coupling) will be saved.
1811 :    
1812 :     $hits must be a pointer to a list of 3-tuples of the sort returned by
1813 :     $fig->coupling_and_evidence.
1814 :    
1815 :     =cut
1816 :    
1817 :     sub add_chr_clusters_and_pins {
1818 :     my($self,$peg,$hits) = @_;
1819 :     my(@clusters,@pins,$x,$sc,$neigh,$pairs,$y,@corr,@orgs,%projection);
1820 :     my($genome,$cluster,$pin,$peg2);
1821 :    
1822 :     if (@$hits > 0)
1823 :     {
1824 :     @clusters = ();
1825 :     @pins = ();
1826 :     push(@clusters,[$peg,map { $_->[1] } @$hits]);
1827 :     foreach $x (@$hits)
1828 :     {
1829 :     ($sc,$neigh,$pairs) = @$x;
1830 :     push(@pins,[$neigh,map { $_->[1] } @$pairs]);
1831 :     foreach $y (@$pairs)
1832 :     {
1833 :     $peg2 = $y->[0];
1834 :     if ($peg2 =~ /^fig\|(\d+\.\d+)/)
1835 :     {
1836 :     $projection{$1}->{$peg2} = 1;
1837 :     }
1838 :     }
1839 :     }
1840 :     @corr = ();
1841 :     @orgs = keys(%projection);
1842 :     if (@orgs > 0)
1843 :     {
1844 :     foreach $genome (sort { $a <=> $b } @orgs)
1845 :     {
1846 :     push(@corr,sort { &FIG::by_fig_id($a,$b) } keys(%{$projection{$genome}}));
1847 :     }
1848 :     push(@pins,[$peg,@corr]);
1849 :     }
1850 :    
1851 :     foreach $cluster (@clusters)
1852 :     {
1853 :     $self->add_chromosomal_cluster($cluster);
1854 :     }
1855 :    
1856 :     foreach $pin (@pins)
1857 :     {
1858 :     $self->add_pch_pin($pin);
1859 :     }
1860 :     }
1861 :     }
1862 :    
1863 :     sub coupling_ev {
1864 :     my($self,$genome1,$sim1,$sim2,$bound) = @_;
1865 :     my($ev,$sc,$i,$j);
1866 :    
1867 :     $ev = [];
1868 :     $sc = 0;
1869 :    
1870 :     $i = 0;
1871 :     $j = 0;
1872 :     while (($i < @$sim1) && ($j < @$sim2))
1873 :     {
1874 :     if ($sim1->[$i]->[0] < $sim2->[$j]->[0])
1875 :     {
1876 :     $i++;
1877 :     }
1878 :     elsif ($sim1->[$i]->[0] > $sim2->[$j]->[0])
1879 :     {
1880 :     $j++;
1881 :     }
1882 :     else
1883 :     {
1884 :     $sc += $self->accumulate_ev($genome1,$sim1->[$i]->[1],$sim2->[$j]->[1],$bound,$ev);
1885 :     $i++;
1886 :     $j++;
1887 :     }
1888 :     }
1889 : overbeek 1.43 return ($self->score([map { $_->[0] } @$ev]),$ev);
1890 : efrank 1.1 }
1891 :    
1892 :     sub accumulate_ev {
1893 :     my($self,$genome1,$feature_ids1,$feature_ids2,$bound,$ev) = @_;
1894 : overbeek 1.43 my($genome2,@locs1,@locs2,$i,$j,$x);
1895 : efrank 1.1
1896 :     if ((@$feature_ids1 == 0) || (@$feature_ids2 == 0)) { return 0 }
1897 :    
1898 :     $feature_ids1->[0] =~ /^fig\|(\d+\.\d+)/;
1899 :     $genome2 = $1;
1900 :     @locs1 = map { $x = $self->feature_location($_); $x ? [&boundaries_of($x)] : () } @$feature_ids1;
1901 :     @locs2 = map { $x = $self->feature_location($_); $x ? [&boundaries_of($x)] : () } @$feature_ids2;
1902 :    
1903 :     for ($i=0; ($i < @$feature_ids1); $i++)
1904 :     {
1905 :     for ($j=0; ($j < @$feature_ids2); $j++)
1906 :     {
1907 :     if (($feature_ids1->[$i] ne $feature_ids2->[$j]) &&
1908 :     &close_enough($locs1[$i],$locs2[$j],$bound))
1909 :     {
1910 :     push(@$ev,[$feature_ids1->[$i],$feature_ids2->[$j]]);
1911 :     }
1912 :     }
1913 :     }
1914 :     }
1915 :    
1916 :     sub close_enough {
1917 :     my($locs1,$locs2,$bound) = @_;
1918 :    
1919 :     # print STDERR &Dumper(["close enough",$locs1,$locs2]);
1920 :     return (($locs1->[0] eq $locs2->[0]) && (abs((($locs1->[1]+$locs1->[2])/2) - (($locs2->[1]+$locs2->[2])/2)) <= $bound));
1921 :     }
1922 :    
1923 :     sub acceptably_close {
1924 :     my($self,$feature_id,$sim_cutoff) = @_;
1925 :     my(%by_org,$id2,$genome,$sim);
1926 :    
1927 :     my($ans) = [];
1928 :    
1929 : overbeek 1.31 foreach $sim ($self->sims($feature_id,1000,$sim_cutoff,"fig"))
1930 : efrank 1.1 {
1931 :     $id2 = $sim->id2;
1932 :     if ($id2 =~ /^fig\|(\d+\.\d+)/)
1933 :     {
1934 :     my $genome = $1;
1935 : overbeek 1.51 if (! $self->is_eukaryotic($genome))
1936 : efrank 1.1 {
1937 :     push(@{$by_org{$genome}},$id2);
1938 :     }
1939 :     }
1940 :     }
1941 :     foreach $genome (sort { $a <=> $b } keys(%by_org))
1942 :     {
1943 :     push(@$ans,[$genome,$by_org{$genome}]);
1944 :     }
1945 :     return $ans;
1946 :     }
1947 :    
1948 :     ################ Translations of PEGsand External Protein Sequences ##########################
1949 :    
1950 :    
1951 :     =pod
1952 :    
1953 :     =head1 translatable
1954 :    
1955 :     usage: $fig->translatable($prot_id)
1956 :    
1957 :     The system takes any number of sources of protein sequences as input (and builds an nr
1958 :     for the purpose of computing similarities). For each of these input fasta files, it saves
1959 :     (in the DB) a filename, seek address and length so that it can go get the translation if
1960 :     needed. This routine simply returns true iff info on the translation exists.
1961 :    
1962 :     =cut
1963 :    
1964 :     sub translatable {
1965 :     my($self,$prot) = @_;
1966 :    
1967 :     return &translation_length($self,$prot) ? 1 : 0;
1968 :     }
1969 :    
1970 :    
1971 :     =pod
1972 :    
1973 :     =head1 translation_length
1974 :    
1975 :     usage: $len = $fig->translation_length($prot_id)
1976 :    
1977 :     The system takes any number of sources of protein sequences as input (and builds an nr
1978 :     for the purpose of computing similarities). For each of these input fasta files, it saves
1979 :     (in the DB) a filename, seek address and length so that it can go get the translation if
1980 :     needed. This routine returns the length of a translation. This does not require actually
1981 :     retrieving the translation.
1982 :    
1983 :     =cut
1984 :    
1985 :     sub translation_length {
1986 :     my($self,$prot) = @_;
1987 :    
1988 :     $prot =~ s/^([^\|]+\|[^\|]+)\|.*$/$1/;
1989 :     my $rdbH = $self->db_handle;
1990 :     my $relational_db_response = $rdbH->SQL("SELECT slen FROM protein_sequence_seeks
1991 :     WHERE id = \'$prot\' ");
1992 :    
1993 :     return (@$relational_db_response == 1) ? $relational_db_response->[0]->[0] : undef;
1994 :     }
1995 :    
1996 :    
1997 :     =pod
1998 :    
1999 :     =head1 get_translation
2000 :    
2001 :     usage: $translation = $fig->get_translation($prot_id)
2002 :    
2003 :     The system takes any number of sources of protein sequences as input (and builds an nr
2004 :     for the purpose of computing similarities). For each of these input fasta files, it saves
2005 :     (in the DB) a filename, seek address and length so that it can go get the translation if
2006 :     needed. This routine returns a protein sequence.
2007 :    
2008 :     =cut
2009 :    
2010 :     sub get_translation {
2011 :     my($self,$id) = @_;
2012 :     my($rdbH,$relational_db_response,$fileN,$file,$fh,$seek,$ln,$tran);
2013 :    
2014 :     $rdbH = $self->db_handle;
2015 :     $id =~ s/^([^\|]+\|[^\|]+)\|.*$/$1/;
2016 :    
2017 :     $relational_db_response = $rdbH->SQL("SELECT fileno, seek, len FROM protein_sequence_seeks WHERE id = \'$id\' ");
2018 :    
2019 :     if ($relational_db_response && @$relational_db_response == 1)
2020 :     {
2021 :     ($fileN,$seek,$ln) = @{$relational_db_response->[0]};
2022 :     if (($fh = $self->openF($self->N2file($fileN))) &&
2023 :     ($ln > 10))
2024 :     {
2025 :     seek($fh,$seek,0);
2026 :     read($fh,$tran,$ln-1);
2027 :     $tran =~ s/\s//g;
2028 :     return $tran;
2029 :     }
2030 :     }
2031 :     return '';
2032 :     }
2033 :    
2034 :     =pod
2035 :    
2036 :     =head1 mapped_prot_ids
2037 :    
2038 :     usage: @mapped = $fig->mapped_prot_ids($prot)
2039 :    
2040 :     This routine is at the heart of maintaining synonyms for protein sequences. The system
2041 :     determines which protein sequences are "essentially the same". These may differ in length
2042 :     (presumably due to miscalled starts), but the tails are identical (and the heads are not "too" extended).
2043 :     Anyway, the set of synonyms is returned as a list of 2-tuples [Id,length] sorted
2044 :     by length.
2045 :    
2046 :     =cut
2047 :    
2048 :     sub mapped_prot_ids {
2049 :     my($self,$id) = @_;
2050 :    
2051 :     my $rdbH = $self->db_handle;
2052 :     my $relational_db_response = $rdbH->SQL("SELECT maps_to FROM peg_synonyms WHERE syn_id = \'$id\' ");
2053 :     if ($relational_db_response && (@$relational_db_response == 1))
2054 :     {
2055 :     $id = $relational_db_response->[0]->[0];
2056 :     }
2057 :    
2058 :     $relational_db_response = $rdbH->SQL("SELECT syn_id,syn_ln,maps_to_ln FROM peg_synonyms WHERE maps_to = \'$id\' ");
2059 :     if ($relational_db_response && (@$relational_db_response > 0))
2060 :     {
2061 :     return ([$id,$relational_db_response->[0]->[2]],map { [$_->[0],$_->[1]] } @$relational_db_response);
2062 :     }
2063 :     else
2064 :     {
2065 :     return ([$id,$self->translation_length($id)]);
2066 :     }
2067 : overbeek 1.14 }
2068 :    
2069 :     sub maps_to_id {
2070 :     my($self,$id) = @_;
2071 :    
2072 :     my $rdbH = $self->db_handle;
2073 :     my $relational_db_response = $rdbH->SQL("SELECT maps_to FROM peg_synonyms WHERE syn_id = \'$id\' ");
2074 :     return ($relational_db_response && (@$relational_db_response == 1)) ? $relational_db_response->[0]->[0] : $id;
2075 : efrank 1.1 }
2076 :    
2077 :     ################ Assignments of Function to PEGs ##########################
2078 :    
2079 :     =pod
2080 :    
2081 :     =head1 function_of
2082 :    
2083 :     usage: @functions = $fig->function_of($peg) OR
2084 :     $function = $fig->function_of($peg,$user)
2085 :    
2086 :     In a list context, you get back a list of 2-tuples. Each 2-tuple is of the
2087 :     form [MadeBy,Function].
2088 :    
2089 :     In a scalar context,
2090 :    
2091 :     1. user is "master" if not specified
2092 :     2. function returned is the user's, if one exists; otherwise, master's, if one exists
2093 :    
2094 :     In a scalar context, you get just the function.
2095 :    
2096 :     =cut
2097 :    
2098 :     # Note that we do not return confidence. I propose a separate function to get both
2099 :     # function and confidence
2100 :     #
2101 :     sub function_of {
2102 :     my($self,$id,$user) = @_;
2103 :     my($relational_db_response,@tmp,$entry,$i);
2104 :     my $wantarray = wantarray();
2105 :     my $rdbH = $self->db_handle;
2106 :    
2107 :     if (($id =~ /^fig\|(\d+\.\d+\.peg\.\d+)/) && ($wantarray || $user))
2108 :     {
2109 :     if (($relational_db_response = $rdbH->SQL("SELECT made_by,assigned_function FROM assigned_functions WHERE ( prot = \'$id\' )")) &&
2110 :     (@$relational_db_response >= 1))
2111 :     {
2112 :     @tmp = sort { $a->[0] cmp $b->[0] } map { [$_->[0],$_->[1]] } @$relational_db_response;
2113 :     for ($i=0; ($i < @tmp) && ($tmp[$i]->[0] ne "master"); $i++) {}
2114 :     if ($i < @tmp)
2115 :     {
2116 :     $entry = splice(@tmp,$i,1);
2117 :     unshift @tmp, ($entry);
2118 :     }
2119 :    
2120 :     my $val;
2121 :     if ($wantarray) { return @tmp }
2122 :     elsif ($user && ($val = &extract_by_who(\@tmp,$user))) { return $val }
2123 :     elsif ($user && ($val = &extract_by_who(\@tmp,"master"))) { return $val }
2124 :     else { return "" }
2125 :     }
2126 :     }
2127 :     else
2128 :     {
2129 :     if (($relational_db_response = $rdbH->SQL("SELECT assigned_function FROM assigned_functions WHERE ( prot = \'$id\' AND made_by = \'master\' )")) &&
2130 :     (@$relational_db_response >= 1))
2131 :     {
2132 :     return $wantarray ? (["master",$relational_db_response->[0]->[0]]) : $relational_db_response->[0]->[0];
2133 :     }
2134 :     }
2135 :    
2136 :     return $wantarray ? () : "";
2137 :     }
2138 :    
2139 :     =pod
2140 :    
2141 :     =head1 translated_function_of
2142 :    
2143 :     usage: $function = $fig->translated_function_of($peg,$user)
2144 :    
2145 :     You get just the translated function.
2146 :    
2147 :     =cut
2148 :    
2149 :     sub translated_function_of {
2150 :     my($self,$id,$user) = @_;
2151 :    
2152 :     my $func = $self->function_of($id,$user);
2153 :     if ($func)
2154 :     {
2155 :     $func = $self->translate_function($func);
2156 :     }
2157 :     return $func;
2158 :     }
2159 :    
2160 :    
2161 :     sub extract_by_who {
2162 :     my($xL,$who) = @_;
2163 :     my($i);
2164 :    
2165 :     for ($i=0; ($i < @$xL) && ($xL->[$i]->[0] ne $who); $i++) {}
2166 :     return ($i < @$xL) ? $xL->[$i]->[1] : "";
2167 :     }
2168 :    
2169 :    
2170 :     =pod
2171 :    
2172 :     =head1 translate_function
2173 :    
2174 :     usage: $translated_func = $fig->translate_function($func)
2175 :    
2176 :     Translates a function based on the function.synonyms table.
2177 :    
2178 :     =cut
2179 :    
2180 :     sub translate_function {
2181 :     my($self,$function) = @_;
2182 :    
2183 :     my ($tran,$from,$to,$line);
2184 :     if (! ($tran = $self->{_function_translation}))
2185 :     {
2186 :     $tran = {};
2187 :     if (open(TMP,"<$FIG_Config::global/function.synonyms"))
2188 :     {
2189 :     while (defined($line = <TMP>))
2190 :     {
2191 : golsen 1.44 chomp $line;
2192 : efrank 1.1 ($from,$to) = split(/\t/,$line);
2193 :     $tran->{$from} = $to;
2194 :     }
2195 :     close(TMP);
2196 :     }
2197 : overbeek 1.22 foreach $from (keys(%$tran))
2198 :     {
2199 :     $to = $tran->{$from};
2200 :     if ($tran->{$to})
2201 :     {
2202 :     delete $tran->{$from};
2203 :     }
2204 :     }
2205 : efrank 1.1 $self->{_function_translation} = $tran;
2206 :     }
2207 : overbeek 1.4
2208 :     while ($to = $tran->{$function})
2209 :     {
2210 :     $function = $to;
2211 :     }
2212 :     return $function;
2213 : efrank 1.1 }
2214 :    
2215 :     =pod
2216 :    
2217 :     =head1 assign_function
2218 :    
2219 :     usage: $fig->assign_function($peg,$user,$function,$confidence)
2220 :    
2221 :     Assigns a function. Note that confidence can (and should be if unusual) included.
2222 :     Note that no annotation is written. This should normally be done in a separate
2223 :     call of the form
2224 :    
2225 :    
2226 :    
2227 :     =cut
2228 :    
2229 :     sub assign_function {
2230 :     my($self,$peg,$user,$function,$confidence) = @_;
2231 :     my($role,$roleQ);
2232 :    
2233 :     my $rdbH = $self->db_handle;
2234 :     $confidence = $confidence ? $confidence : "";
2235 :     my $genome = $self->genome_of($peg);
2236 :    
2237 :     $rdbH->SQL("DELETE FROM assigned_functions WHERE ( prot = \'$peg\' AND made_by = \'$user\' )");
2238 :    
2239 :     my $funcQ = quotemeta $function;
2240 :     $rdbH->SQL("INSERT INTO assigned_functions ( prot, made_by, assigned_function, quality, org ) VALUES ( \'$peg\', \'$user\', \'$funcQ\', \'$confidence\', \'$genome\' )");
2241 :     $rdbH->SQL("DELETE FROM roles WHERE ( prot = \'$peg\' AND made_by = \'$user\' )");
2242 :    
2243 :     foreach $role (&roles_of_function($function))
2244 :     {
2245 :     $roleQ = quotemeta $role;
2246 :     $rdbH->SQL("INSERT INTO roles ( prot, role, made_by, org ) VALUES ( \'$peg\', '$roleQ\', \'$user\', \'$genome\' )");
2247 :     }
2248 :    
2249 :     &verify_dir("$FIG_Config::organisms/$genome/UserModels");
2250 :     if ($user ne "master")
2251 :     {
2252 :     &verify_dir("$FIG_Config::organisms/$genome/UserModels/$user");
2253 :     }
2254 :    
2255 : overbeek 1.66 my $file;
2256 :     if ((($user eq "master") && ($file = "$FIG_Config::organisms/$genome/assigned_functions") && open(TMP,">>$file")) ||
2257 :     (($user ne "master") && ($file = "$FIG_Config::organisms/$genome/UserModels/$user/assigned_functions") && open(TMP,">>$file")))
2258 : efrank 1.1 {
2259 :     flock(TMP,LOCK_EX) || confess "cannot lock assigned_functions";
2260 :     seek(TMP,0,2) || confess "failed to seek to the end of the file";
2261 :     print TMP "$peg\t$function\t$confidence\n";
2262 :     close(TMP);
2263 : overbeek 1.66 chmod(0777,$file);
2264 : efrank 1.1 return 1;
2265 :     }
2266 :     return 0;
2267 :     }
2268 :    
2269 :     sub hypo {
2270 :     my $x = (@_ == 1) ? $_[0] : $_[1];
2271 :    
2272 : overbeek 1.23 if (! $x) { return 1 }
2273 :     if ($x =~ /hypoth/i) { return 1 }
2274 :     if ($x =~ /conserved protein/i) { return 1 }
2275 : overbeek 1.63 if ($x =~ /gene product/i) { return 1 }
2276 :     if ($x =~ /interpro/i) { return 1 }
2277 :     if ($x =~ /B[sl][lr]\d/i) { return 1 }
2278 :     if ($x =~ /^U\d/) { return 1 }
2279 :     if ($x =~ /^orf/i) { return 1 }
2280 :     if ($x =~ /uncharacterized/i) { return 1 }
2281 :     if ($x =~ /psedogene/i) { return 1 }
2282 :     if ($x =~ /^predicted/i) { return 1 }
2283 :     if ($x =~ /AGR_/) { return 1 }
2284 : overbeek 1.51 if ($x =~ /similar to/i) { return 1 }
2285 : overbeek 1.63 if ($x =~ /similarity/i) { return 1 }
2286 :     if ($x =~ /glimmer/i) { return 1 }
2287 : overbeek 1.23 if ($x =~ /unknown/i) { return 1 }
2288 :     return 0;
2289 : efrank 1.1 }
2290 :    
2291 :     ############################ Similarities ###############################
2292 :    
2293 :     =pod
2294 :    
2295 :     =head1 sims
2296 :    
2297 :     usage: @sims = $fig->sims($peg,$maxN,$maxP,$select)
2298 :    
2299 :     Returns a list of similarities for $peg such that
2300 :    
2301 :     there will be at most $maxN similarities,
2302 :    
2303 :     each similarity will have a P-score <= $maxP, and
2304 :    
2305 :     $select gives processing instructions:
2306 :    
2307 :     "raw" means that the similarities will not be expanded (by far fastest option)
2308 :     "fig" means return only similarities to fig genes
2309 :     "all" means that you want all the expanded similarities.
2310 :    
2311 :     By "expanded", we refer to taking a "raw similarity" against an entry in the non-redundant
2312 :     protein collection, and converting it to a set of similarities (one for each of the
2313 :     proteins that are essentially identical to the representative in the nr).
2314 :    
2315 :     =cut
2316 :    
2317 :     sub sims {
2318 : overbeek 1.29 my ($self,$id,$maxN,$maxP,$select,$max_expand) = @_;
2319 : efrank 1.1 my($sim);
2320 : overbeek 1.29 $max_expand = defined($max_expand) ? $max_expand : $maxN;
2321 : efrank 1.1
2322 :     my @sims = ();
2323 :     my @maps_to = $self->mapped_prot_ids($id);
2324 :     if (@maps_to > 0)
2325 :     {
2326 :     my $rep_id = $maps_to[0]->[0];
2327 :     my @entry = grep { $_->[0] eq $id } @maps_to;
2328 :     if ((@entry == 1) && defined($entry[0]->[1]))
2329 :     {
2330 :     if ((! defined($maps_to[0]->[1])) ||
2331 :     (! defined($entry[0]->[1])))
2332 :     {
2333 :     print STDERR &Dumper(\@maps_to,\@entry);
2334 :     confess "bad";
2335 :     }
2336 :     my $delta = $maps_to[0]->[1] - $entry[0]->[1];
2337 :     my @raw_sims = &get_raw_sims($self,$rep_id,$maxN,$maxP);
2338 : efrank 1.2 if ($id ne $rep_id)
2339 : efrank 1.1 {
2340 : efrank 1.2 foreach $sim (@raw_sims)
2341 :     {
2342 : efrank 1.1
2343 :     $sim->[0] = $id;
2344 :     $sim->[6] -= $delta;
2345 :     $sim->[7] -= $delta;
2346 :     }
2347 :     }
2348 : efrank 1.2 unshift(@raw_sims,bless([$id,$rep_id,100.00,undef,undef,undef,1,$entry[0]->[1],$delta+1,$maps_to[0]->[1],0.0,,undef,$entry[0]->[1],$maps_to[0]->[1],"blastp",0,0],'Sim'));
2349 : overbeek 1.37 @sims = grep { $_->id1 ne $_->id2 } &expand_raw_sims($self,\@raw_sims,$maxP,$select,0,$max_expand+1);
2350 : efrank 1.1 }
2351 :     }
2352 :     return @sims;
2353 :     }
2354 :    
2355 :     sub expand_raw_sims {
2356 : overbeek 1.29 my($self,$raw_sims,$maxP,$select,$dups,$max_expand) = @_;
2357 : efrank 1.1 my($sim,$id2,%others,$x);
2358 :    
2359 :     my @sims = ();
2360 :     foreach $sim (@$raw_sims)
2361 :     {
2362 :     next if ($sim->psc > $maxP);
2363 :     $id2 = $sim->id2;
2364 :     next if ($others{$id2} && (! $dups));
2365 :     $others{$id2} = 1;
2366 : overbeek 1.37 if (($select && ($select eq "raw")) || ($max_expand <= 0))
2367 : efrank 1.1 {
2368 :     push(@sims,$sim);
2369 :     }
2370 :     else
2371 :     {
2372 :     my @relevant;
2373 : overbeek 1.29 $max_expand--;
2374 :    
2375 : efrank 1.1 my @maps_to = $self->mapped_prot_ids($id2);
2376 :     if ((! $select) || ($select eq "fig"))
2377 :     {
2378 :     @relevant = grep { $_->[0] =~ /^fig/ } @maps_to;
2379 :     }
2380 :     elsif ($select && ($select =~ /^ext/i))
2381 :     {
2382 :     @relevant = grep { $_->[0] !~ /^fig/ } @maps_to;
2383 :     }
2384 :     else
2385 :     {
2386 :     @relevant = @maps_to;
2387 :     }
2388 :    
2389 :     foreach $x (@relevant)
2390 :     {
2391 :     my $sim1 = [@$sim];
2392 :     my($x_id,$x_ln) = @$x;
2393 :     defined($x_ln) || confess "x_ln id2=$id2 x_id=$x_id";
2394 :     defined($maps_to[0]->[1]) || confess "maps_to";
2395 :     my $delta2 = $maps_to[0]->[1] - $x_ln;
2396 :     $sim1->[1] = $x_id;
2397 :     $sim1->[8] -= $delta2;
2398 :     $sim1->[9] -= $delta2;
2399 :     bless($sim1,"Sim");
2400 :     push(@sims,$sim1);
2401 :     }
2402 :     }
2403 :     }
2404 :     return @sims;
2405 :     }
2406 :    
2407 :     sub get_raw_sims {
2408 :     my($self,$rep_id,$maxN,$maxP) = @_;
2409 :     my(@sims,$seek,$fileN,$ln,$fh,$file,$readN,$readC,@lines,$i,$sim);
2410 :     my($sim_chunk,$psc,$id2);
2411 :    
2412 :     $maxN = $maxN ? $maxN : 500;
2413 :    
2414 :     @sims = ();
2415 :     my $rdbH = $self->db_handle;
2416 :     my $relational_db_response = $rdbH->SQL("SELECT seek, fileN, len FROM sim_seeks WHERE id = \'$rep_id\' ");
2417 :     foreach $sim_chunk (@$relational_db_response)
2418 :     {
2419 :     ($seek,$fileN,$ln) = @$sim_chunk;
2420 :     $file = $self->N2file($fileN);
2421 :     $fh = $self->openF($file);
2422 :     if (! $fh)
2423 :     {
2424 :     confess "could not open sims for $file";
2425 :     }
2426 :     seek($fh,$seek,0);
2427 :     $readN = read($fh,$readC,$ln-1);
2428 :     ($readN == ($ln-1))
2429 :     || confess "could not read the block of sims at $seek for $ln - 1 characters; $readN actually read from $file\n$readC";
2430 :     @lines = grep {
2431 :     (@$_ == 15) &&
2432 :     ($_->[12] =~ /^\d+$/) &&
2433 :     ($_->[13] =~ /^\d+$/) &&
2434 :     ($_->[6] =~ /^\d+$/) &&
2435 :     ($_->[7] =~ /^\d+$/) &&
2436 :     ($_->[8] =~ /^\d+$/) &&
2437 :     ($_->[9] =~ /^\d+$/) &&
2438 :     ($_->[2] =~ /^[0-9.]+$/) &&
2439 :     ($_->[10] =~ /^[0-9.e-]+$/)
2440 :     }
2441 :     map { [split(/\t/,$_),"blastp"] }
2442 :     split(/\n/,$readC);
2443 :    
2444 :     @lines = sort { $a->[10] <=> $b->[10] } @lines;
2445 :    
2446 :     for ($i=0; ($i < @lines); $i++)
2447 :     {
2448 :     $psc = $lines[$i]->[10];
2449 :     $id2 = $lines[$i]->[1];
2450 :     if ($maxP >= $psc)
2451 :     {
2452 :     $sim = $lines[$i];
2453 :     bless($sim,"Sim");
2454 :     push(@sims,$sim);
2455 :     if (@sims == $maxN) { return @sims }
2456 :     }
2457 :     }
2458 :     }
2459 :     return @sims;
2460 :     }
2461 :    
2462 : overbeek 1.73 sub bbhs {
2463 :     my($self,$peg,$cutoff) = @_;
2464 : overbeek 1.74 my($sim,$peg2,$genome2,$i,@sims2,%seen);
2465 : overbeek 1.73
2466 :     $cutoff = defined($cutoff) ? $cutoff : 1.0e-10;
2467 :     my @bbhs = ();
2468 :    
2469 :     my $genome1 = $self->genome_of($peg);
2470 : overbeek 1.74 $seen{$genome1} = 1;
2471 : overbeek 1.73 foreach $sim ($self->sims($peg,10000,$cutoff,"fig"))
2472 :     {
2473 :     $peg2 = $sim->id2;
2474 :     $genome2 = $self->genome_of($peg2);
2475 : overbeek 1.74 next if ($seen{$genome2});
2476 :     $seen{$genome2} = 1;
2477 : overbeek 1.73 @sims2 = $self->sims($peg2,10000,$cutoff,"fig");
2478 :     for ($i=0; ($i < @sims2) && ($self->genome_of($sims2[$i]->id2) ne $genome1); $i++) {}
2479 :     if (($i < @sims2) && ($sims2[$i]->id2 eq $peg))
2480 :     {
2481 :     push(@bbhs,[$peg2,$sim->psc]);
2482 :     }
2483 :     }
2484 :     return @bbhs;
2485 :     }
2486 :    
2487 : efrank 1.1 =pod
2488 :    
2489 :     =head1 dsims
2490 :    
2491 :     usage: @sims = $fig->dsims($peg,$maxN,$maxP,$select)
2492 :    
2493 :     Returns a list of similarities for $peg such that
2494 :    
2495 :     there will be at most $maxN similarities,
2496 :    
2497 :     each similarity will have a P-score <= $maxP, and
2498 :    
2499 :     $select gives processing instructions:
2500 :    
2501 :     "raw" means that the similarities will not be expanded (by far fastest option)
2502 :     "fig" means return only similarities to fig genes
2503 :     "all" means that you want all the expanded similarities.
2504 :    
2505 :     By "expanded", we refer to taking a "raw similarity" against an entry in the non-redundant
2506 :     protein collection, and converting it to a set of similarities (one for each of the
2507 :     proteins that are essentially identical to the representative in the nr).
2508 :    
2509 :     The "dsims" or "dynamic sims" are not precomputed. They are computed using a heuristic which
2510 :     is much faster than blast, but misses some similarities. Essentially, you have an "index" or
2511 :     representative sequences, a quick blast is done against it, and if there are any hits these are
2512 :     used to indicate which sub-databases to blast against.
2513 :    
2514 :     =cut
2515 :    
2516 :     sub dsims {
2517 :     my($self,$id,$seq,$maxN,$maxP,$select) = @_;
2518 :     my($sim,$sub_dir,$db,$hit,@hits,%in);
2519 :    
2520 :     my @index = &blastit($id,$seq,"$FIG_Config::global/SimGen/exemplar.fasta",1.0e-3);
2521 :     foreach $sim (@index)
2522 :     {
2523 :     if ($sim->id2 =~ /_(\d+)$/)
2524 :     {
2525 :     $in{$1}++;
2526 :     }
2527 :     }
2528 :    
2529 :     @hits = ();
2530 :     foreach $db (keys(%in))
2531 :     {
2532 :     $sub_dir = $db % 1000;
2533 :     push(@hits,&blastit($id,$seq,"$FIG_Config::global/SimGen/AccessSets/$sub_dir/$db",$maxP));
2534 :    
2535 :     }
2536 :    
2537 :     if (@hits == 0)
2538 :     {
2539 :     push(@hits,&blastit($id,$seq,"$FIG_Config::global/SimGen/nohit.fasta",$maxP));
2540 :     }
2541 :    
2542 :     @hits = sort { ($a->psc <=> $b->psc) or ($a->iden cmp $b->iden) } grep { $_->id2 ne $id } @hits;
2543 :     if ($maxN && ($maxN < @hits)) { $#hits = $maxN - 1 }
2544 : overbeek 1.69 return &expand_raw_sims($self,\@hits,$maxP,$select);
2545 : efrank 1.1 }
2546 :    
2547 :     sub blastit {
2548 :     my($id,$seq,$db,$maxP) = @_;
2549 :    
2550 :     if (! $maxP) { $maxP = 1.0e-5 }
2551 :     my $tmp = &Blast::blastp([[$id,$seq]],$db,"-e $maxP");
2552 :     my $tmp1 = $tmp->{$id};
2553 :     if ($tmp1)
2554 :     {
2555 :     return @$tmp1;
2556 :     }
2557 :     return ();
2558 :     }
2559 :    
2560 : overbeek 1.33 sub related_by_func_sim {
2561 :     my($self,$peg,$user) = @_;
2562 :     my($func,$sim,$id2,%related);
2563 :    
2564 :     if (($func = $self->function_of($peg,$user)) && (! &FIG::hypo($func)))
2565 :     {
2566 :     foreach $sim ($self->sims($peg,500,1,"fig",500))
2567 :     {
2568 :     $id2 = $sim->id2;
2569 :     if ($func eq $self->function_of($id2,$user))
2570 :     {
2571 :     $related{$id2} = 1;
2572 :     }
2573 :     }
2574 :     }
2575 :     return keys(%related);
2576 :     }
2577 :    
2578 : efrank 1.1 ################################# chromosomal clusters ####################################
2579 :    
2580 :     =pod
2581 :    
2582 :     =head1 in_cluster_with
2583 :    
2584 :     usage: @pegs = $fig->in_cluster_with($peg)
2585 :    
2586 :     Returns the set of pegs that are thought to be clustered with $peg (on the
2587 :     chromosome).
2588 :    
2589 :     =cut
2590 :    
2591 :     sub in_cluster_with {
2592 :     my($self,$peg) = @_;
2593 :     my($set,$id,%in);
2594 :    
2595 :     return $self->in_set_with($peg,"chromosomal_clusters","cluster_id");
2596 :     }
2597 :    
2598 :     =pod
2599 :    
2600 :     =head1 add_chromosomal_clusters
2601 :    
2602 :     usage: $fig->add_chromosomal_clusters($file)
2603 :    
2604 :     The given file is supposed to contain one predicted chromosomal cluster per line (either
2605 :     comma or tab separated pegs). These will be added (to the extent they are new) to those
2606 :     already in $FIG_Config::global/chromosomal_clusters.
2607 :    
2608 :     =cut
2609 :    
2610 :    
2611 :     sub add_chromosomal_clusters {
2612 :     my($self,$file) = @_;
2613 :     my($set,$added);
2614 :    
2615 :     open(TMPCLUST,"<$file")
2616 :     || die "aborted";
2617 :     while (defined($set = <TMPCLUST>))
2618 :     {
2619 :     print STDERR ".";
2620 : golsen 1.44 chomp $set;
2621 : efrank 1.1 $added += $self->add_chromosomal_cluster([split(/[\t,]+/,$set)]);
2622 :     }
2623 :     close(TMPCLUST);
2624 :    
2625 :     if ($added)
2626 :     {
2627 :     my $rdbH = $self->db_handle;
2628 :     $self->export_set("chromosomal_clusters","cluster_id","$FIG_Config::global/chromosomal_clusters");
2629 :     return 1;
2630 :     }
2631 :     return 0;
2632 :     }
2633 :    
2634 :     #=pod
2635 :     #
2636 :     #=head1 export_chromosomal_clusters
2637 :     #
2638 :     #usage: $fig->export_chromosomal_clusters
2639 :     #
2640 :     #Invoking this routine writes the set of chromosomal clusters as known in the
2641 :     #relational DB back to $FIG_Config::global/chromosomal_clusters.
2642 :     #
2643 :     #=cut
2644 :     #
2645 :     sub export_chromosomal_clusters {
2646 :     my($self) = @_;
2647 :    
2648 :     $self->export_set("chromosomal_clusters","cluster_id","$FIG_Config::global/chromosomal_clusters");
2649 :     }
2650 :    
2651 :     sub add_chromosomal_cluster {
2652 :     my($self,$ids) = @_;
2653 :     my($id,$set,%existing,%in,$new,$existing,$new_id);
2654 :    
2655 :     # print STDERR "adding cluster ",join(",",@$ids),"\n";
2656 :     foreach $id (@$ids)
2657 :     {
2658 :     foreach $set ($self->in_sets($id,"chromosomal_clusters","cluster_id"))
2659 :     {
2660 :     $existing{$set} = 1;
2661 :     foreach $id ($self->ids_in_set($set,"chromosomal_clusters","cluster_id"))
2662 :     {
2663 :     $in{$id} = 1;
2664 :     }
2665 :     }
2666 :     }
2667 :     # print &Dumper(\%existing,\%in);
2668 :    
2669 :     $new = 0;
2670 :     foreach $id (@$ids)
2671 :     {
2672 :     if (! $in{$id})
2673 :     {
2674 :     $in{$id} = 1;
2675 :     $new++;
2676 :     }
2677 :     }
2678 :     # print STDERR "$new new ids\n";
2679 :     if ($new)
2680 :     {
2681 :     foreach $existing (keys(%existing))
2682 :     {
2683 :     $self->delete_set($existing,"chromosomal_clusters","cluster_id");
2684 :     }
2685 :     $new_id = $self->next_set("chromosomal_clusters","cluster_id");
2686 :     # print STDERR "adding new cluster $new_id\n";
2687 :     $self->insert_set($new_id,[keys(%in)],"chromosomal_clusters","cluster_id");
2688 :     return 1;
2689 :     }
2690 :     return 0;
2691 :     }
2692 :    
2693 :     ################################# PCH pins ####################################
2694 :    
2695 :     =pod
2696 :    
2697 :     =head1 in_pch_pin_with
2698 :    
2699 :     usage: $fig->in_pch_pin_with($peg)
2700 :    
2701 :     Returns the set of pegs that are believed to be "pinned" to $peg (in the
2702 :     sense that PCHs occur containing these pegs over significant phylogenetic
2703 :     distances).
2704 :    
2705 :     =cut
2706 :    
2707 :     sub in_pch_pin_with {
2708 :     my($self,$peg) = @_;
2709 :     my($set,$id,%in);
2710 :    
2711 :     return $self->in_set_with($peg,"pch_pins","pin");
2712 :     }
2713 :    
2714 :     =pod
2715 :    
2716 :     =head1 add_pch_pins
2717 :    
2718 :     usage: $fig->add_pch_pins($file)
2719 :    
2720 :     The given file is supposed to contain one set of pinned pegs per line (either
2721 :     comma or tab seprated pegs). These will be added (to the extent they are new) to those
2722 :     already in $FIG_Config::global/pch_pins.
2723 :    
2724 :     =cut
2725 :    
2726 :     sub add_pch_pins {
2727 :     my($self,$file) = @_;
2728 :     my($set,$added);
2729 :    
2730 :     open(TMPCLUST,"<$file")
2731 :     || die "aborted";
2732 :     while (defined($set = <TMPCLUST>))
2733 :     {
2734 :     print STDERR ".";
2735 : golsen 1.44 chomp $set;
2736 : efrank 1.1 my @tmp = split(/[\t,]+/,$set);
2737 :     if (@tmp < 200)
2738 :     {
2739 :     $added += $self->add_pch_pin([@tmp]);
2740 :     }
2741 :     }
2742 :     close(TMPCLUST);
2743 :    
2744 :     if ($added)
2745 :     {
2746 :     my $rdbH = $self->db_handle;
2747 :     $self->export_set("pch_pins","pin","$FIG_Config::global/pch_pins");
2748 :     return 1;
2749 :     }
2750 :     return 0;
2751 :     }
2752 :    
2753 :     sub export_pch_pins {
2754 :     my($self) = @_;
2755 :    
2756 :     $self->export_set("pch_pins","pin","$FIG_Config::global/pch_pins");
2757 :     }
2758 :    
2759 :     sub add_pch_pin {
2760 :     my($self,$ids) = @_;
2761 :     my($id,$set,%existing,%in,$new,$existing,$new_id);
2762 :    
2763 :     # print STDERR "adding cluster ",join(",",@$ids),"\n";
2764 :     foreach $id (@$ids)
2765 :     {
2766 :     foreach $set ($self->in_sets($id,"pch_pins","pin"))
2767 :     {
2768 :     $existing{$set} = 1;
2769 :     foreach $id ($self->ids_in_set($set,"pch_pins","pin"))
2770 :     {
2771 :     $in{$id} = 1;
2772 :     }
2773 :     }
2774 :     }
2775 :     # print &Dumper(\%existing,\%in);
2776 :    
2777 :     $new = 0;
2778 :     foreach $id (@$ids)
2779 :     {
2780 :     if (! $in{$id})
2781 :     {
2782 :     $in{$id} = 1;
2783 :     $new++;
2784 :     }
2785 :     }
2786 :    
2787 :     if ($new)
2788 :     {
2789 : overbeek 1.9 if (keys(%in) < 300)
2790 : efrank 1.1 {
2791 : overbeek 1.9 foreach $existing (keys(%existing))
2792 :     {
2793 :     $self->delete_set($existing,"pch_pins","pin");
2794 :     }
2795 :     $new_id = $self->next_set("pch_pins","pin");
2796 :     # print STDERR "adding new pin $new_id\n";
2797 :     $self->insert_set($new_id,[keys(%in)],"pch_pins","pin");
2798 :     }
2799 :     else
2800 :     {
2801 :     $new_id = $self->next_set("pch_pins","pin");
2802 :     # print STDERR "adding new pin $new_id\n";
2803 :     $self->insert_set($new_id,$ids,"pch_pins","pin");
2804 : efrank 1.1 }
2805 :     return 1;
2806 :     }
2807 :     return 0;
2808 :     }
2809 :    
2810 :     ################################# Annotations ####################################
2811 :    
2812 :     =pod
2813 :    
2814 :     =head1 add_annotation
2815 :    
2816 :     usage: $fig->add_annotation($fid,$user,$annotation)
2817 :    
2818 :     $annotation is added as a time-stamped annotation to $peg showing $user as the
2819 :     individual who added the annotation.
2820 :    
2821 :     =cut
2822 :    
2823 :     sub add_annotation {
2824 :     my($self,$feature_id,$user,$annotation) = @_;
2825 :     my($genome);
2826 :    
2827 :     # print STDERR "add: fid=$feature_id user=$user annotation=$annotation\n";
2828 :     if ($genome = $self->genome_of($feature_id))
2829 :     {
2830 :     my $file = "$FIG_Config::organisms/$genome/annotations";
2831 :     my $fileno = $self->file2N($file);
2832 :     my $time_made = time;
2833 : overbeek 1.17 my $ma = ($annotation =~ /^Set master function to/);
2834 :    
2835 : efrank 1.1
2836 :     if (open(TMP,">>$file"))
2837 :     {
2838 :     flock(TMP,LOCK_EX) || confess "cannot lock assigned_functions";
2839 :     seek(TMP,0,2) || confess "failed to seek to the end of the file";
2840 :    
2841 :     my $seek1 = tell TMP;
2842 :     print TMP "$feature_id\n$time_made\n$user\n$annotation", (substr($annotation,-1) eq "\n") ? "" : "\n","//\n";
2843 :     my $seek2 = tell TMP;
2844 :     close(TMP);
2845 : disz 1.60 chmod 02777, $file;
2846 : efrank 1.1 my $ln = $seek2 - $seek1;
2847 :     my $rdbH = $self->db_handle;
2848 : overbeek 1.17 if ($rdbH->SQL("INSERT INTO annotation_seeks ( fid, dateof, who, ma, fileno, seek, len ) VALUES ( \'$feature_id\', $time_made, \'$user\', \'$ma\', $fileno, $seek1, $ln )"))
2849 : efrank 1.1 {
2850 :     return 1;
2851 :     }
2852 :     }
2853 :     }
2854 :     return 0;
2855 :     }
2856 :    
2857 :     =pod
2858 :    
2859 : overbeek 1.33 =head1 merged_related_annotations
2860 :    
2861 :     usage: @annotations = $fig->merged_related_annotations($fids)
2862 :    
2863 :     The set of annotations of a set of PEGs ($fids) is returned as a list of 4-tuples.
2864 :     Each entry in the list is of the form [$fid,$timestamp,$user,$annotation].
2865 :    
2866 :     =cut
2867 :    
2868 :     sub merged_related_annotations {
2869 :     my($self,$fids) = @_;
2870 :     my($fid);
2871 :     my(@ann) = ();
2872 :    
2873 :     foreach $fid (@$fids)
2874 :     {
2875 :     push(@ann,$self->feature_annotations1($fid));
2876 :     }
2877 :     return map { $_->[1] = localtime($_->[1]); $_ } sort { $a->[1] <=> $b->[1] } @ann;
2878 :     }
2879 :    
2880 :     =pod
2881 :    
2882 : efrank 1.1 =head1 feature_annotations
2883 :    
2884 :     usage: @annotations = $fig->feature_annotations($fid)
2885 :    
2886 :     The set of annotations of $fid is returned as a list of 4-tuples. Each entry in the list
2887 :     is of the form [$fid,$timestamp,$user,$annotation].
2888 :    
2889 :     =cut
2890 :    
2891 :    
2892 :     sub feature_annotations {
2893 :     my($self,$feature_id) = @_;
2894 : overbeek 1.33
2895 :     return map { $_->[1] = localtime($_->[1]); $_ } $self->feature_annotations1($feature_id);
2896 :     }
2897 :    
2898 :     sub feature_annotations1 {
2899 :     my($self,$feature_id) = @_;
2900 : overbeek 1.16 my($tuple,$fileN,$seek,$ln,$annotation,$feature_idQ);
2901 : efrank 1.1 my($file,$fh);
2902 :    
2903 :     my $rdbH = $self->db_handle;
2904 :     my $relational_db_response = $rdbH->SQL("SELECT fileno, seek, len FROM annotation_seeks WHERE fid = \'$feature_id\' ");
2905 :     my @annotations = ();
2906 :    
2907 :     foreach $tuple (@$relational_db_response)
2908 :     {
2909 :     ($fileN,$seek,$ln) = @$tuple;
2910 : overbeek 1.16 $annotation = $self->read_annotation($fileN,$seek,$ln);
2911 :     $feature_idQ = quotemeta $feature_id;
2912 :     if ($annotation =~ /^$feature_idQ\n(\d+)\n([^\n]+)\n(.*)/s)
2913 : efrank 1.1 {
2914 : overbeek 1.16 push(@annotations,[$feature_id,$1,$2,$3]);
2915 : efrank 1.1 }
2916 : overbeek 1.16 else
2917 : efrank 1.1 {
2918 : overbeek 1.16 print STDERR "malformed annotation\n$annotation\n";
2919 : efrank 1.1 }
2920 :     }
2921 : overbeek 1.33 return sort { $a->[1] <=> $b->[1] } @annotations;
2922 : overbeek 1.16 }
2923 :    
2924 :     sub read_annotation {
2925 :     my($self,$fileN,$seek,$ln) = @_;
2926 :     my($readN,$readC);
2927 :    
2928 :     my $file = $self->N2file($fileN);
2929 :     my $fh = $self->openF($file);
2930 :     if (! $fh)
2931 :     {
2932 :     confess "could not open annotations for $file";
2933 :     }
2934 :     seek($fh,$seek,0);
2935 : overbeek 1.24 $readN = read($fh,$readC,$ln-3);
2936 :     ($readN == ($ln-3))
2937 : overbeek 1.16 || confess "could not read the block of annotations at $seek for $ln characters; $readN actually read from $file\n$readC";
2938 :     return $readC;
2939 : overbeek 1.17 }
2940 :    
2941 : overbeek 1.21 sub epoch_to_readable {
2942 :     my($epoch) = @_;
2943 :    
2944 :     my($sec,$min,$hr,$dd,$mm,$yr) = localtime($epoch);
2945 :     $mm++;
2946 :     $yr += 1900;
2947 :     return "$mm-$dd-$yr:$hr:$min:$sec";
2948 :     }
2949 :    
2950 : overbeek 1.17 sub assignments_made {
2951 :     my($self,$genomes,$who,$date) = @_;
2952 :     my($relational_db_response,$entry,$fid,$fileno,$seek,$len,$ann);
2953 : overbeek 1.30 my($epoch_date,$when,%sofar,$x);
2954 : overbeek 1.17
2955 : overbeek 1.56 if (! defined($genomes)) { $genomes = [$self->genomes] }
2956 :    
2957 : overbeek 1.17 my %genomes = map { $_ => 1 } @$genomes;
2958 : overbeek 1.19 if ($date =~ /^(\d{1,2})\/(\d{1,2})\/(\d{4})$/)
2959 :     {
2960 :     my($mm,$dd,$yyyy) = ($1,$2,$3);
2961 :     $epoch_date = &Time::Local::timelocal(0,0,0,$dd,$mm-1,$yyyy-1900,0,0,0);
2962 :     }
2963 : overbeek 1.62 elsif ($date =~ /^\d+$/)
2964 :     {
2965 :     $epoch_date = $date;
2966 :     }
2967 : overbeek 1.19 else
2968 :     {
2969 :     $epoch_date = 0;
2970 :     }
2971 :     $epoch_date = defined($epoch_date) ? $epoch_date-1 : 0;
2972 : overbeek 1.17 my @assignments = ();
2973 :     my $rdbH = $self->db_handle;
2974 :     if ($who eq "master")
2975 :     {
2976 : overbeek 1.30 $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE ((ma = \'1\') AND (dateof > $epoch_date))");
2977 : overbeek 1.17 }
2978 :     else
2979 :     {
2980 : overbeek 1.30 $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE (( who = \'$who\' ) AND (dateof > $epoch_date))");
2981 : overbeek 1.17 }
2982 :    
2983 :     if ($relational_db_response && (@$relational_db_response > 0))
2984 :     {
2985 :     foreach $entry (@$relational_db_response)
2986 :     {
2987 : overbeek 1.30 ($fid,$when,$fileno,$seek,$len) = @$entry;
2988 : overbeek 1.17 if (($fid =~ /^fig\|(\d+\.\d+)/) && $genomes{$1})
2989 :     {
2990 : overbeek 1.67 if ($len < 4)
2991 :     {
2992 :     print STDERR "BAD: fid=$fid when=$when fileno=$fileno seek=$seek len=$len\n";
2993 :     next;
2994 :     }
2995 : overbeek 1.17 $ann = $self->read_annotation($fileno,$seek,$len);
2996 :    
2997 :     if (($ann =~ /^(fig\|\d+\.\d+\.peg\.\d+)\n(\d+)\n(\S+)\nSet ([^\n]*)function[^\n]*\n(\S[^\n]+\S)/s) &&
2998 :     (($who eq $3) || (($4 eq "master ") && ($who eq "master"))) &&
2999 : overbeek 1.19 ($2 >= $epoch_date))
3000 : overbeek 1.17 {
3001 : overbeek 1.30 if ((! $sofar{$1}) || (($x = $sofar{$1}) && ($when > $x->[0])))
3002 :     {
3003 :     $sofar{$1} = [$when,$5];
3004 :     }
3005 : overbeek 1.17 }
3006 :     }
3007 :     }
3008 :     }
3009 : overbeek 1.30 @assignments = map { $x = $sofar{$_}; [$_,$x->[1]] } keys(%sofar);
3010 : overbeek 1.17 return @assignments;
3011 : efrank 1.1 }
3012 :    
3013 : overbeek 1.56 sub annotations_made {
3014 :     my($self,$genomes,$who,$date) = @_;
3015 :     my($relational_db_response,$entry,$fid,$fileno,$seek,$len,$ann);
3016 :     my($epoch_date,$when,@annotations);
3017 :    
3018 :     if (! defined($genomes)) { $genomes = [$self->genomes] }
3019 :    
3020 :     my %genomes = map { $_ => 1 } @$genomes;
3021 :     if ($date =~ /^(\d{1,2})\/(\d{1,2})\/(\d{4})$/)
3022 :     {
3023 :     my($mm,$dd,$yyyy) = ($1,$2,$3);
3024 :     $epoch_date = &Time::Local::timelocal(0,0,0,$dd,$mm-1,$yyyy-1900,0,0,0);
3025 :     }
3026 : overbeek 1.62 elsif ($date =~ /^\d+$/)
3027 :     {
3028 :     $epoch_date = $date;
3029 :     }
3030 : overbeek 1.56 else
3031 :     {
3032 :     $epoch_date = 0;
3033 :     }
3034 :     $epoch_date = defined($epoch_date) ? $epoch_date-1 : 0;
3035 :     my @annotations = ();
3036 :     my $rdbH = $self->db_handle;
3037 :     if ($who eq "master")
3038 :     {
3039 :     $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE ((ma = \'1\') AND (dateof > $epoch_date))");
3040 :     }
3041 :     else
3042 :     {
3043 :     $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE (( who = \'$who\' ) AND (dateof > $epoch_date))");
3044 :     }
3045 :    
3046 :     if ($relational_db_response && (@$relational_db_response > 0))
3047 :     {
3048 :     foreach $entry (@$relational_db_response)
3049 :     {
3050 :     ($fid,$when,$fileno,$seek,$len) = @$entry;
3051 :     if (($fid =~ /^fig\|(\d+\.\d+)/) && $genomes{$1})
3052 :     {
3053 :     $ann = $self->read_annotation($fileno,$seek,$len);
3054 :    
3055 : overbeek 1.57 if ($ann =~ /^(fig\|\d+\.\d+\.peg\.\d+)\n(\d+)\n(\S+)\n(.*\S)/s)
3056 : overbeek 1.56 {
3057 :     push(@annotations,[$1,$2,$3,$4]);
3058 :     }
3059 :     }
3060 :     }
3061 :     }
3062 :     return @annotations;
3063 :     }
3064 :    
3065 : efrank 1.1 ################################# Indexing Features and Functional Roles ####################################
3066 :    
3067 :     =pod
3068 :    
3069 :     =head1 search_index
3070 :    
3071 :     usage: ($pegs,$roles) = $fig->search_pattern($pattern)
3072 :    
3073 :     All pegs that "match" $pattern are put into a list, and $pegs will be a
3074 :     pointer to that list.
3075 :    
3076 :     All roles that "match" $pattern are put into a list, and $roles will be a
3077 :     pointer to that list.
3078 :    
3079 :     The notion of "match $pattern" is intentionally left undefined. For now, you
3080 :     will probably get only entries in which each word id $pattern occurs exactly,
3081 :     but that is not a long term commitment.
3082 :    
3083 :     =cut
3084 :    
3085 :     sub search_index {
3086 :     my($self,$pattern) = @_;
3087 :     my($patternQ,@raw,@pegs,@roles);
3088 :    
3089 :     &clean_tmp;
3090 :     $patternQ = $pattern;
3091 :     $patternQ =~ s/\s+/;/g;
3092 :     $patternQ =~ s/\./\\./g;
3093 :    
3094 :     # print STDERR "pattern=$pattern patternQ=$patternQ\n";
3095 :     @raw = `$FIG_Config::ext_bin/glimpse -y -H $FIG_Config::data/Indexes -i -w \'$patternQ\'`;
3096 :     @pegs = sort { &FIG::by_fig_id($a->[0],$b->[0]) }
3097 :     map { $_ =~ s/^\S+:\s+//; [split(/\t/,$_)] }
3098 :     grep { $_ =~ /^\S+peg.index/ } @raw;
3099 :     my %roles = map { $_ =~ s/^\S+:\s+//; $_ => 1} grep { $_ =~ /^\S+role.index/ } @raw;
3100 :     @roles = sort keys(%roles);
3101 :    
3102 :     return ([@pegs],[@roles]);
3103 :     }
3104 :    
3105 :     ################################# Loading Databases ####################################
3106 :    
3107 :    
3108 :     #=pod
3109 :     #
3110 :     #=head1 load_all
3111 :     #
3112 :     #usage: load_all
3113 :     #
3114 :     #This function is supposed to reload all entries into the database and do
3115 :     #whatever is required to properly support indexing of pegs and roles.
3116 :     #
3117 :     #=cut
3118 :    
3119 :     sub load_all {
3120 :    
3121 : overbeek 1.15 &run("index_contigs");
3122 :     &run("compute_genome_counts");
3123 : efrank 1.1 &run("load_features");
3124 :     &run("index_sims");
3125 :     &run("load_peg_mapping");
3126 :     &run("index_translations");
3127 :     &run("add_assertions_of_function");
3128 :     &run("load_protein_families");
3129 :     &run("load_external_orgs");
3130 :     &run("load_chromosomal_clusters");
3131 :     &run("load_pch_pins");
3132 :     &run("index_neighborhoods");
3133 :     &run("index_annotations");
3134 :     &run("load_ec_names");
3135 :     &run("load_kegg");
3136 : overbeek 1.35 &run("load_distances");
3137 : efrank 1.1 &run("make_indexes");
3138 : overbeek 1.70 &run("format_peg_dbs");
3139 : efrank 1.1 }
3140 :    
3141 :     ################################# Automated Assignments ####################################
3142 :    
3143 :     =pod
3144 :    
3145 :     =head1 auto_assign
3146 :    
3147 :     usage: $assignment = &FIG::auto_assign($peg,$seq)
3148 :    
3149 :     This returns an automated assignment for $peg. $seq is optional; if it is not
3150 :     present, then it is assumed that similarities already exist for $peg. $assignment is set
3151 :     to either
3152 :    
3153 :     Function
3154 :     or
3155 :     Function\tW
3156 :    
3157 :     if it is felt that the assertion is pretty weak.
3158 :    
3159 :     =cut
3160 :    
3161 :     sub auto_assign {
3162 :     my($peg,$seq) = @_;
3163 :    
3164 : overbeek 1.71 my $cmd = $seq ? "echo \"$peg\t$seq\" | $FIG_Config::bin/auto_assign | $FIG_Config::bin/make_calls" : "echo \"$peg\" | $FIG_Config::bin/auto_assign | $FIG_Config::bin/make_calls";
3165 : efrank 1.1 # print STDERR $cmd;
3166 :     my(@tmp) = `$cmd`;
3167 :     if ((@tmp == 1) && ($tmp[0] =~ /^\S+\t(\S.*\S)/))
3168 :     {
3169 :     return $1;
3170 :     }
3171 :     else
3172 :     {
3173 :     return "hypothetical protein";
3174 :     }
3175 :     }
3176 :    
3177 :     ################################# Protein Families ####################################
3178 :    
3179 :     =pod
3180 :    
3181 :     =head1 all_protein_families
3182 :    
3183 :     usage: @all = $fig->all_protein_families
3184 :    
3185 :     Returns a list of the ids of all of the protein families currently defined.
3186 :    
3187 :     =cut
3188 :    
3189 :     sub all_protein_families {
3190 :     my($self) = @_;
3191 :    
3192 :     return $self->all_sets("protein_families","family");
3193 :     }
3194 :    
3195 :     =pod
3196 :    
3197 :     =head1 ids_in_family
3198 :    
3199 :     usage: @pegs = $fig->ids_in_family($family)
3200 :    
3201 :     Returns a list of the pegs in $family.
3202 :    
3203 :     =cut
3204 :    
3205 :     sub ids_in_family {
3206 :     my($self,$family) = @_;
3207 :    
3208 :     return $self->ids_in_set($family,"protein_families","family");
3209 :     }
3210 :    
3211 :     =pod
3212 :    
3213 :     =head1 family_function
3214 :    
3215 :     usage: $func = $fig->family_function($family)
3216 :    
3217 :     Returns the putative function of all of the pegs in $family. Remember, we
3218 :     are defining "protein family" as a set of homologous proteins that have the
3219 :     same function.
3220 :    
3221 :     =cut
3222 :    
3223 :     sub family_function {
3224 :     my($self,$family) = @_;
3225 :     my($relational_db_response);
3226 :     my $rdbH = $self->db_handle;
3227 :    
3228 :     defined($family) || confess "family is missing";
3229 :     if (($relational_db_response = $rdbH->SQL("SELECT function FROM family_function WHERE ( family = $family)")) &&
3230 :     (@$relational_db_response >= 1))
3231 :     {
3232 :     return $relational_db_response->[0]->[0];
3233 :     }
3234 :     return "";
3235 :     }
3236 :    
3237 :     =pod
3238 :    
3239 :     =head1 sz_family
3240 :    
3241 :     usage: $n = $fig->sz_family($family)
3242 :    
3243 :     Returns the number of pegs in $family.
3244 :    
3245 :     =cut
3246 :    
3247 :     sub sz_family {
3248 :     my($self,$family) = @_;
3249 :    
3250 :     return $self->sz_set($family,"protein_families","family");
3251 :     }
3252 :    
3253 :     =pod
3254 :    
3255 :     =head1 in_family
3256 :    
3257 :     usage: @pegs = $fig->in_family($family)
3258 :    
3259 :     Returns the pegs in $family.
3260 :    
3261 :     =cut
3262 :    
3263 :     sub in_family {
3264 :     my($self,$id) = @_;
3265 :    
3266 :     my @in = $self->in_sets($id,"protein_families","family");
3267 :     return (@in > 0) ? $in[0] : "";
3268 :     }
3269 :    
3270 :     ################################# Abstract Set Routines ####################################
3271 :    
3272 :     sub all_sets {
3273 :     my($self,$relation,$set_name) = @_;
3274 :     my($relational_db_response);
3275 :    
3276 :     my $rdbH = $self->db_handle;
3277 :    
3278 :     if (($relational_db_response = $rdbH->SQL("SELECT DISTINCT $set_name FROM $relation")) &&
3279 :     (@$relational_db_response >= 1))
3280 :     {
3281 :     return map { $_->[0] } @$relational_db_response;
3282 :     }
3283 :     return ();
3284 :     }
3285 :    
3286 :     sub next_set {
3287 :     my($self,$relation,$set_name) = @_;
3288 :     my($relational_db_response);
3289 :    
3290 :     my $rdbH = $self->db_handle;
3291 :    
3292 :     if (($relational_db_response = $rdbH->SQL("SELECT MAX($set_name) FROM $relation")) &&
3293 :     (@$relational_db_response == 1))
3294 :     {
3295 :     return $relational_db_response->[0]->[0] + 1;
3296 :     }
3297 :     }
3298 :    
3299 :     sub ids_in_set {
3300 :     my($self,$which,$relation,$set_name) = @_;
3301 :     my($relational_db_response);
3302 :    
3303 :     my $rdbH = $self->db_handle;
3304 :     if (defined($which) && ($which =~ /^\d+$/))
3305 :     {
3306 :     if (($relational_db_response = $rdbH->SQL("SELECT id FROM $relation WHERE ( $set_name = $which)")) &&
3307 :     (@$relational_db_response >= 1))
3308 :     {
3309 :     return sort { by_fig_id($a,$b) } map { $_->[0] } @$relational_db_response;
3310 :     }
3311 :     }
3312 :     return ();
3313 :     }
3314 :    
3315 :     sub in_sets {
3316 :     my($self,$id,$relation,$set_name) = @_;
3317 :     my($relational_db_response);
3318 :    
3319 :     my $rdbH = $self->db_handle;
3320 :    
3321 :     if (($relational_db_response = $rdbH->SQL("SELECT $set_name FROM $relation WHERE ( id = \'$id\' )")) &&
3322 :     (@$relational_db_response >= 1))
3323 :     {
3324 :     return map { $_->[0] } @$relational_db_response;
3325 :     }
3326 :     return ();
3327 :     }
3328 :    
3329 :     sub sz_set {
3330 :     my($self,$which,$relation,$set_name) = @_;
3331 :     my($relational_db_response);
3332 :    
3333 :     my $rdbH = $self->db_handle;
3334 :    
3335 :     if (($relational_db_response = $rdbH->SQL("SELECT COUNT(*) FROM $relation WHERE ( $set_name = $which)")) &&
3336 :     (@$relational_db_response == 1))
3337 :     {
3338 :     return $relational_db_response->[0]->[0];
3339 :     }
3340 :     return 0;
3341 :     }
3342 :    
3343 :     sub delete_set {
3344 :     my($self,$set,$relation,$set_name) = @_;
3345 :    
3346 :     # print STDERR "deleting set $set\n";
3347 :     my $rdbH = $self->db_handle;
3348 :    
3349 :     return $rdbH->SQL("DELETE FROM $relation WHERE ( $set_name = $set )");
3350 :     }
3351 :    
3352 :     sub insert_set {
3353 :     my($self,$set,$ids,$relation,$set_name) = @_;
3354 :     my($id);
3355 :    
3356 :     # print STDERR "inserting set $set containing ",join(",",@$ids),"\n";
3357 :     my $rdbH = $self->db_handle;
3358 :    
3359 : overbeek 1.23 my @ids = grep { length($_) < 255 } @$ids;
3360 :     if (@ids < 2) { return 0 }
3361 :    
3362 : efrank 1.1 my $rc = 1;
3363 : overbeek 1.23 foreach $id (@ids)
3364 : efrank 1.1 {
3365 :     if (! $rdbH->SQL("INSERT INTO $relation ( $set_name,id ) VALUES ( $set,\'$id\' )"))
3366 :     {
3367 :     $rc = 0;
3368 :     }
3369 :     }
3370 :     # print STDERR " rc=$rc\n";
3371 :     return $rc;
3372 :     }
3373 :    
3374 :     sub in_set_with {
3375 :     my($self,$peg,$relation,$set_name) = @_;
3376 :     my($set,$id,%in);
3377 :    
3378 :     foreach $set ($self->in_sets($peg,$relation,$set_name))
3379 :     {
3380 :     foreach $id ($self->ids_in_set($set,$relation,$set_name))
3381 :     {
3382 :     $in{$id} = 1;
3383 :     }
3384 :     }
3385 :     return sort { &by_fig_id($a,$b) } keys(%in);
3386 :     }
3387 :    
3388 :    
3389 :     sub export_set {
3390 :     my($self,$relation,$set_name,$file) = @_;
3391 :     my($pair);
3392 :    
3393 :     my $rdbH = $self->db_handle;
3394 :     my $relational_db_response = $rdbH->SQL("SELECT $set_name, id FROM $relation");
3395 :    
3396 :     open(TMP,">$file")
3397 :     || die "could not open $file";
3398 :     flock(TMP,LOCK_EX) || confess "cannot lock $file";
3399 :     seek(TMP,0,2) || confess "failed to seek to the end of the file";
3400 :    
3401 :     foreach $pair (sort { ($a->[0] <=> $b->[0]) or &by_fig_id($a->[1],$b->[1]) } @$relational_db_response)
3402 :     {
3403 :     print TMP join("\t",@$pair),"\n";
3404 :     }
3405 :     close(TMP);
3406 :     return 1;
3407 :     }
3408 :    
3409 :     ################################# KEGG Stuff ####################################
3410 :    
3411 :    
3412 :     =pod
3413 :    
3414 :     =head1 all_compounds
3415 :    
3416 :     usage: @compounds = $fig->all_compounds
3417 :    
3418 :     Returns a list containing all of the KEGG compounds.
3419 :    
3420 :     =cut
3421 :    
3422 :     sub all_compounds {
3423 :     my($self) = @_;
3424 :    
3425 :     my $rdbH = $self->db_handle;
3426 :     my $relational_db_response = $rdbH->SQL("SELECT DISTINCT cid FROM comp_name");
3427 :     if (@$relational_db_response > 0)
3428 :     {
3429 :     return sort map { $_->[0] } @$relational_db_response;
3430 :     }
3431 :     return ();
3432 :     }
3433 :    
3434 :     =pod
3435 :    
3436 :     =head1 names_of_compound
3437 :    
3438 :     usage: @names = $fig->names_of_compound
3439 :    
3440 :     Returns a list containing all of the names assigned to the KEGG compounds. The list
3441 :     will be ordered as given by KEGG.
3442 :    
3443 :     =cut
3444 :    
3445 :     sub names_of_compound {
3446 :     my($self,$cid) = @_;
3447 :    
3448 :     my $rdbH = $self->db_handle;
3449 :     my $relational_db_response = $rdbH->SQL("SELECT pos,name FROM comp_name where cid = \'$cid\'");
3450 :     if (@$relational_db_response > 0)
3451 :     {
3452 :     return map { $_->[1] } sort { $a->[0] <=> $b->[0] } @$relational_db_response;
3453 :     }
3454 :     return ();
3455 :     }
3456 :    
3457 :     =pod
3458 :    
3459 :     =head1 comp2react
3460 :    
3461 :    
3462 :     usage: @rids = $fig->comp2react($cid)
3463 :    
3464 :     Returns a list containing all of the reaction IDs for reactions that take $cid
3465 :     as either a substrate or a product.
3466 :    
3467 :     =cut
3468 :    
3469 :     sub comp2react {
3470 :     my($self,$cid) = @_;
3471 :    
3472 :     my $rdbH = $self->db_handle;
3473 :     my $relational_db_response = $rdbH->SQL("SELECT rid FROM reaction_to_compound where cid = \'$cid\'");
3474 :     if (@$relational_db_response > 0)
3475 :     {
3476 :     return sort map { $_->[0] } @$relational_db_response;
3477 :     }
3478 :     return ();
3479 :     }
3480 :    
3481 :     =pod
3482 :    
3483 :     =head1 cas
3484 :    
3485 :     usage: $cas = $fig->cas($cid)
3486 :    
3487 :     Returns the CAS ID for the compound, if known.
3488 :    
3489 :     =cut
3490 :    
3491 :     sub cas {
3492 :     my($self,$cid) = @_;
3493 :    
3494 :     my $rdbH = $self->db_handle;
3495 :     my $relational_db_response = $rdbH->SQL("SELECT cas FROM comp_cas where cid = \'$cid\'");
3496 :     if (@$relational_db_response == 1)
3497 :     {
3498 :     return $relational_db_response->[0]->[0];
3499 :     }
3500 :     return "";
3501 :     }
3502 :    
3503 :     =pod
3504 :    
3505 :     =head1 cas_to_cid
3506 :    
3507 :     usage: $cid = $fig->cas_to_cid($cas)
3508 :    
3509 :     Returns the compound id (cid), given the CAS ID.
3510 :    
3511 :     =cut
3512 :    
3513 :     sub cas_to_cid {
3514 :     my($self,$cas) = @_;
3515 :    
3516 :     my $rdbH = $self->db_handle;
3517 :     my $relational_db_response = $rdbH->SQL("SELECT cid FROM comp_cas where cas = \'$cas\'");
3518 :     if (@$relational_db_response == 1)
3519 :     {
3520 :     return $relational_db_response->[0]->[0];
3521 :     }
3522 :     return "";
3523 :     }
3524 :    
3525 :     =pod
3526 :    
3527 :     =head1 all_reactions
3528 :    
3529 :     usage: @rids = $fig->all_reactions
3530 :    
3531 :     Returns a list containing all of the KEGG reaction IDs.
3532 :    
3533 :     =cut
3534 :    
3535 :     sub all_reactions {
3536 :     my($self) = @_;
3537 :    
3538 :     my $rdbH = $self->db_handle;
3539 :     my $relational_db_response = $rdbH->SQL("SELECT DISTINCT rid FROM reaction_to_compound");
3540 :     if (@$relational_db_response > 0)
3541 :     {
3542 :     return sort map { $_->[0] } @$relational_db_response;
3543 :     }
3544 :     return ();
3545 :     }
3546 :    
3547 :     =pod
3548 :    
3549 :     =head1 reversible
3550 :    
3551 :     usage: $rev = $fig->reversible($rid)
3552 :    
3553 :     Returns true iff the reactions had a "main direction" designated as "<=>";
3554 :    
3555 :     =cut
3556 :    
3557 :     sub reversible {
3558 :     my($self,$rid) = @_;
3559 :    
3560 :     my $rdbH = $self->db_handle;
3561 :     my $relational_db_response = $rdbH->SQL("SELECT reversible FROM reversible where rid = \'$rid\'");
3562 :     if (@$relational_db_response == 1)
3563 :     {
3564 :     return $relational_db_response->[0]->[0];
3565 :     }
3566 :     return 1;
3567 :     }
3568 :    
3569 :     =pod
3570 :    
3571 :     =head1 reaction2comp
3572 :    
3573 :     usage: @tuples = $fig->reaction2comp($rid,$which)
3574 :    
3575 :     Returns the "substrates" iff $which == 0. In any event (i.e., whether you ask for substrates
3576 :     or products), you get back a list of 3-tuples. Each 3-tuple will contain
3577 :    
3578 :     [$cid,$stoich,$main]
3579 :    
3580 :     Stoichiometry is normally numeric, but can be things like "n" or "(n+1)".
3581 :     $main is 1 iff the compound is considered "main" or "connectable".
3582 :    
3583 :     =cut
3584 :    
3585 :     sub reaction2comp {
3586 :     my($self,$rid,$which) = @_;
3587 :    
3588 :     my $rdbH = $self->db_handle;
3589 :     my $relational_db_response = $rdbH->SQL("SELECT cid,stoich,main FROM reaction_to_compound where rid = \'$rid\' and setn = \'$which\'");
3590 :     if (@$relational_db_response > 0)
3591 :     {
3592 :     return sort { $a->[0] cmp $b->[0] } map { $_->[1] =~ s/\s+//g; $_ } @$relational_db_response;
3593 :     }
3594 :     return ();
3595 :     }
3596 :    
3597 :     =pod
3598 :    
3599 :     =head1 catalyzed_by
3600 :    
3601 :     usage: @ecs = $fig->catalyzed_by($rid)
3602 :    
3603 :     Returns the ECs that are reputed to catalyze the reaction. Note that we are currently
3604 :     just returning the ECs that KEGG gives. We need to handle the incompletely specified forms
3605 :     (e.g., 1.1.1.-), but we do not do it yet.
3606 :    
3607 :     =cut
3608 :    
3609 :     sub catalyzed_by {
3610 :     my($self,$rid) = @_;
3611 :    
3612 :     my $rdbH = $self->db_handle;
3613 :     my $relational_db_response = $rdbH->SQL("SELECT role FROM reaction_to_enzyme where rid = \'$rid\'");
3614 :     if (@$relational_db_response > 0)
3615 :     {
3616 :     return sort map { $_->[0] } @$relational_db_response;
3617 :     }
3618 :     return ();
3619 :     }
3620 :    
3621 :     =pod
3622 :    
3623 :     =head1 catalyzes
3624 :    
3625 :     usage: @ecs = $fig->catalyzes($role)
3626 :    
3627 :     Returns the rids of the reactions catalyzed by the "role" (normally an EC).
3628 :    
3629 :     =cut
3630 :    
3631 :     sub catalyzes {
3632 :     my($self,$role) = @_;
3633 :    
3634 :     my $rdbH = $self->db_handle;
3635 :     my $relational_db_response = $rdbH->SQL("SELECT rid FROM reaction_to_enzyme where role = \'$role\'");
3636 :     if (@$relational_db_response > 0)
3637 :     {
3638 :     return sort map { $_->[0] } @$relational_db_response;
3639 :     }
3640 :     return ();
3641 :     }
3642 :    
3643 :    
3644 :     =pod
3645 :    
3646 :     =head1 displayable_reaction
3647 :    
3648 :     usage: $display_format = $fig->displayable_reaction($rid)
3649 :    
3650 :     Returns a string giving the displayable version of a reaction.
3651 :    
3652 :     =cut
3653 :    
3654 :     sub displayable_reaction {
3655 :     my($self,$rid) = @_;
3656 :    
3657 :     my @tmp = `grep $rid $FIG_Config::data/KEGG/reaction_name.lst`;
3658 :     if (@tmp > 0)
3659 :     {
3660 : golsen 1.44 chomp $tmp[0];
3661 : efrank 1.1 return $tmp[0];
3662 :     }
3663 :     return $rid;
3664 :     }
3665 :    
3666 :     =pod
3667 :    
3668 :     =head1 all_maps
3669 :    
3670 :     usage: @maps = $fig->all_maps
3671 :    
3672 :     Returns a list containing all of the KEGG maps that the system knows about (the
3673 :     maps need to be periodically updated).
3674 :    
3675 :     =cut
3676 :    
3677 :     sub all_maps {
3678 :     my($self,$ec) = @_;
3679 :    
3680 :     my $rdbH = $self->db_handle;
3681 :     my $relational_db_response = $rdbH->SQL("SELECT DISTINCT map FROM ec_map ");
3682 :     if (@$relational_db_response > 0)
3683 :     {
3684 :     return map { $_->[0] } @$relational_db_response;
3685 :     }
3686 :     return ();
3687 :     }
3688 :    
3689 :     =pod
3690 :    
3691 :     =head1 ec_to_maps
3692 :    
3693 :     usage: @maps = $fig->ec_to_maps($ec)
3694 :    
3695 :     Returns the set of maps that contain $ec as a functional role. $ec is usually an EC number,
3696 :     but in the more general case, it can be a functional role.
3697 :    
3698 :     =cut
3699 :    
3700 :     sub ec_to_maps {
3701 :     my($self,$ec) = @_;
3702 :    
3703 :     my $rdbH = $self->db_handle;
3704 :     my $relational_db_response = $rdbH->SQL("SELECT map FROM ec_map WHERE ( ec = \'$ec\' )");
3705 :     if (@$relational_db_response > 0)
3706 :     {
3707 :     return map { $_->[0] } @$relational_db_response;
3708 :     }
3709 :     return ();
3710 :     }
3711 :    
3712 :    
3713 :     =pod
3714 :    
3715 :     =head1 map_to_ecs
3716 :    
3717 :     usage: @ecs = $fig->map_to_ecs($map)
3718 :    
3719 :     Returns the set of functional roles (usually ECs) that are contained in the functionality
3720 :     depicted by $map.
3721 :    
3722 :     =cut
3723 :    
3724 :     sub map_to_ecs {
3725 :     my($self,$map) = @_;
3726 :    
3727 :     my $rdbH = $self->db_handle;
3728 :     my $relational_db_response = $rdbH->SQL("SELECT ec FROM ec_map WHERE ( map = \'$map\' )");
3729 :     if (@$relational_db_response > 0)
3730 :     {
3731 :     return map { $_->[0] } @$relational_db_response;
3732 :     }
3733 :     return ();
3734 :     }
3735 :    
3736 :     =pod
3737 :    
3738 :     =head1 map_name
3739 :    
3740 :     usage: $name = $fig->map_name($map)
3741 :    
3742 :     Returns the descriptive name covering the functionality depicted by $map.
3743 :    
3744 :     =cut
3745 :    
3746 :     sub map_name {
3747 :     my($self,$map) = @_;
3748 :    
3749 :     my $rdbH = $self->db_handle;
3750 :     my $relational_db_response = $rdbH->SQL("SELECT mapname FROM map_name WHERE ( map = \'$map\' )");
3751 :     if (@$relational_db_response == 1)
3752 :     {
3753 :     return $relational_db_response->[0]->[0];
3754 :     }
3755 :     return "";
3756 :     }
3757 :    
3758 :     ################################# Functional Roles ####################################
3759 :    
3760 :     =pod
3761 :    
3762 :     =head1 neighborhood_of_role
3763 :    
3764 :     usage: @roles = $fig->neighborhood_of_role($role)
3765 :    
3766 :     Returns a list of functional roles that we consider to be "the neighborhood" of $role.
3767 :    
3768 :     =cut
3769 :    
3770 :     sub neighborhood_of_role {
3771 :     my($self,$role) = @_;
3772 :     my($readC);
3773 :    
3774 :     my $file = "$FIG_Config::global/role.neighborhoods";
3775 :     my $rdbH = $self->db_handle;
3776 :     my $roleQ = quotemeta $role;
3777 :     my $relational_db_response = $rdbH->SQL("SELECT seek, len FROM neigh_seeks WHERE role = \'$roleQ\' ");
3778 :     if (@$relational_db_response == 1)
3779 :     {
3780 :     my($seek,$ln) = @{$relational_db_response->[0]};
3781 :     my $fh = $self->openF($file);
3782 :     seek($fh,$seek,0);
3783 :     my $readN = read($fh,$readC,$ln-1);
3784 :     ($readN == ($ln-1))
3785 :     || confess "could not read the block of sims at $seek for $ln - 1 characters; $readN actually read from $file\n$readC";
3786 :     return grep { $_ && ($_ !~ /^\/\//) } split(/\n/,$readC);
3787 :     }
3788 :     return ();
3789 :     }
3790 :    
3791 :     =pod
3792 :    
3793 :     =head1 roles_of_function
3794 :    
3795 :     usage: @roles = $fig->roles_of_function($func)
3796 :    
3797 :     Returns a list of the functional roles implemented by $func.
3798 :    
3799 :     =cut
3800 :    
3801 :     sub roles_of_function {
3802 :     my($func) = @_;
3803 :    
3804 :     return (split(/\s*[\/;]\s+/,$func),($func =~ /\d+\.\d+\.\d+\.\d+/g));
3805 :     }
3806 :    
3807 :     =pod
3808 :    
3809 :     =head1 seqs_with_role
3810 :    
3811 :     usage: @pegs = $fig->seqs_with_role($role,$who)
3812 :    
3813 :     Returns a list of the pegs that implement $role. If $who is not given, it
3814 :     defaults to "master". The system returns all pegs with an assignment made by
3815 :     either "master" or $who (if it is different than the master) that implement $role.
3816 :     Note that this includes pegs for which the "master" annotation disagrees with that
3817 :     of $who, the master's implements $role, and $who's does not.
3818 :    
3819 :     =cut
3820 :    
3821 :     sub seqs_with_role {
3822 : overbeek 1.26 my($self,$role,$who,$genome) = @_;
3823 :     my($relational_db_response,$query);
3824 : efrank 1.1
3825 : overbeek 1.32 my $roleQ = quotemeta $role;
3826 :    
3827 : efrank 1.1 $who = $who ? $who : "master";
3828 :     my $rdbH = $self->db_handle;
3829 :    
3830 :     my $who_cond;
3831 :     if ($who eq "master")
3832 :     {
3833 :     $who_cond = "( made_by = \'master\' OR made_by = \'unknown\' )";
3834 :     }
3835 :     else
3836 :     {
3837 :     $who_cond = "( made_by = \'master\' OR made_by = \'$who\' OR made_by = \'unknown\')";
3838 :     }
3839 : overbeek 1.26
3840 :     if (! $genome)
3841 :     {
3842 : overbeek 1.32 $query = "SELECT distinct prot FROM roles WHERE (( role = \'$roleQ\' ) AND $who_cond )";
3843 : overbeek 1.26 }
3844 :     else
3845 :     {
3846 : overbeek 1.32 $query = "SELECT distinct prot FROM roles WHERE (( role = \'$roleQ\' ) AND $who_cond AND (org = \'$genome\'))";
3847 : overbeek 1.26 }
3848 : efrank 1.1 return (($relational_db_response = $rdbH->SQL($query)) && (@$relational_db_response >= 1)) ?
3849 :     map { $_->[0] } @$relational_db_response : ();
3850 :     }
3851 :    
3852 :     =pod
3853 :    
3854 :     =head1 seqs_with_roles_in_genomes
3855 :    
3856 :     usage: $result = $fig->seqs_with_roles_in_genomes($genomes,$roles,$made_by)
3857 :    
3858 :     This routine takes a pointer to a list of genomes ($genomes) and a pointer to a list of
3859 :     roles ($roles) and looks up all of the sequences that connect to those roles according
3860 :     to either the master assignments or those made by $made_by. Again, you will get assignments
3861 :     for which the "master" assignment connects, but the $made_by does not.
3862 :    
3863 :     A hash is returned. The keys to the hash are genome IDs for which at least one sequence
3864 :     was found. $result->{$genome} will itself be a hash, assuming that at least one sequence
3865 :     was found for $genome. $result->{$genome}->{$role} will be set to a pointer to a list of
3866 :     2-tuples. Each 2-tuple will contain [$peg,$function], where $function is the one for
3867 :     $made_by (which may not be the one that connected).
3868 :    
3869 :     =cut
3870 :    
3871 :     sub seqs_with_roles_in_genomes {
3872 :     my($self,$genomes,$roles,$made_by) = @_;
3873 :     my($genome,$role,$roleQ,$role_cond,$made_by_cond,$query,$relational_db_response,$peg,$genome_cond,$hit);
3874 :     my $rdbH = $self->db_handle;
3875 :     my $result = {}; # foreach $genome ($self->genomes) { $result->{$genome} = {} }
3876 :     if (! $made_by) { $made_by = 'master' }
3877 :     if ((@$genomes > 0) && (@$roles > 0))
3878 :     {
3879 :     $genome_cond = "(" . join(" OR ",map { "( org = \'$_\' )" } @$genomes) . ")";
3880 :     $role_cond = "(" . join(" OR ",map { $roleQ = quotemeta $_; "( role = \'$roleQ\' )" } @$roles) . ")";
3881 :     $made_by_cond = ($made_by eq 'master') ? "(made_by = 'master')" : "(made_by = 'master' OR made_by = '$made_by')";
3882 :     $query = "SELECT distinct prot, role FROM roles WHERE ( $made_by_cond AND $genome_cond AND $role_cond )";
3883 :     if (($relational_db_response = $rdbH->SQL($query)) && (@$relational_db_response >= 1))
3884 :     {
3885 :     foreach $hit (@$relational_db_response)
3886 :     {
3887 :     ($peg,$role) = @$hit;
3888 :     $genome = $self->genome_of($peg);
3889 :     push(@{ $result->{$genome}->{$role} },[$peg,scalar $self->function_of($peg,$made_by)]);
3890 :     }
3891 :     }
3892 :     }
3893 :     return $result;
3894 :     }
3895 :    
3896 :     =pod
3897 :    
3898 :     =head1 largest_clusters
3899 :    
3900 :     usage: @clusters = $fig->largest_clusters($roles,$user)
3901 :    
3902 : mkubal 1.54 This routine can be used to find the largest clusters containing some of the
3903 : efrank 1.1 designated set of roles. A list of clusters is returned. Each cluster is a pointer to
3904 :     a list of pegs.
3905 :    
3906 :     =cut
3907 :    
3908 :     sub largest_clusters {
3909 :     my($self,$roles,$user,$sort_by_unique_functions) = @_;
3910 :     my($genome,$x,$role,$y,$peg,$loc,$contig,$beg,$end,%pegs,@pegs,$i,$j);
3911 :    
3912 :     my $ss = $self->seqs_with_roles_in_genomes([$self->genomes],$roles,$user);
3913 :     my @clusters = ();
3914 :    
3915 :     foreach $genome (keys(%$ss))
3916 :     {
3917 :     my %pegs;
3918 :     $x = $ss->{$genome};
3919 :     foreach $role (keys(%$x))
3920 :     {
3921 :     $y = $x->{$role};
3922 :     foreach $peg (map { $_->[0] } @$y)
3923 :     {
3924 :     if ($loc = $self->feature_location($peg))
3925 :     {
3926 :     ($contig,$beg,$end) = &FIG::boundaries_of($loc);
3927 :     $pegs{$peg} = [$peg,$contig,int(($beg + $end) / 2)];
3928 :     }
3929 :     }
3930 :     }
3931 :    
3932 :     @pegs = sort { ($pegs{$a}->[1] cmp $pegs{$b}->[1]) or ($pegs{$a}->[2] <=> $pegs{$b}->[2]) } keys(%pegs);
3933 :     $i = 0;
3934 :     while ($i < $#pegs)
3935 :     {
3936 :     for ($j=$i+1; ($j < @pegs) && &close_enough_locs($pegs{$pegs[$j-1]},$pegs{$pegs[$j]}); $j++) {}
3937 :     if ($j > ($i+1))
3938 :     {
3939 :     push(@clusters,[@pegs[$i..$j-1]]);
3940 :     }
3941 :     $i = $j;
3942 :     }
3943 :     }
3944 :     if ($sort_by_unique_functions)
3945 :     {
3946 :     @clusters = sort { $self->unique_functions($b,$user) <=> $self->unique_functions($a,$user) } @clusters;
3947 :     }
3948 :     else
3949 :     {
3950 :     @clusters = sort { @$b <=> @$a } @clusters;
3951 :     }
3952 :     return @clusters;
3953 :     }
3954 :    
3955 :     sub unique_functions {
3956 :     my($self,$pegs,$user) = @_;
3957 :     my($peg,$func,%seen);
3958 :    
3959 :     foreach $peg (@$pegs)
3960 :     {
3961 :     if ($func = $self->function_of($peg,$user))
3962 :     {
3963 :     $seen{$func} = 1;
3964 :     }
3965 :     }
3966 :     return scalar keys(%seen);
3967 :     }
3968 :    
3969 :     sub close_enough_locs {
3970 :     my($x,$y) = @_;
3971 :    
3972 :     return (($x->[1] eq $y->[1]) && (abs($x->[2] - $y->[2]) < 5000));
3973 :     }
3974 :    
3975 : overbeek 1.59 sub candidates_for_role {
3976 :     my($self,$role,$genome,$cutoff,$user) = @_;
3977 :     my($peg);
3978 : overbeek 1.64
3979 : overbeek 1.59 $user = $user ? $user : "master";
3980 :    
3981 :     my @cand = map { $_->[0] }
3982 :     sort { $a->[1] <=> $b->[1] }
3983 :     map { $peg = $_; [$peg,$self->crude_estimate_of_distance($genome,&FIG::genome_of($peg))] }
3984 :     $self->seqs_with_role($role,$user);
3985 :    
3986 : overbeek 1.64 return $self->candidates_for_role_from_known($genome,$cutoff,\@cand);
3987 :     }
3988 :    
3989 :     sub candidates_for_role_from_known {
3990 :     my($self,$genome,$cutoff,$known) = @_;
3991 :     my($peg);
3992 :    
3993 :     my @cand = @$known;
3994 : overbeek 1.59 my $hits = {};
3995 :     my $seen = {};
3996 : overbeek 1.68 my $how_many = (@cand > 10) ? 9 : scalar @cand;
3997 :     &try_to_locate($self,$genome,$hits,[@cand[0..$how_many]],$seen,$cutoff);
3998 : overbeek 1.59 if (keys(%$hits) == 0)
3999 :     {
4000 :     splice(@cand,0,$how_many+1);
4001 :     &try_to_locate($self,$genome,$hits,\@cand,$seen,$cutoff);
4002 :     }
4003 :     return sort {$hits->{$a}->[0] <=> $hits->{$b}->[0]} keys(%$hits);
4004 :     }
4005 :    
4006 :     sub try_to_locate {
4007 :     my($self,$genome,$hits,$to_try,$seen,$cutoff) = @_;
4008 :     my($prot,$id2,$psc,$id2a,$x,$sim);
4009 :    
4010 :     if (! $cutoff) { $cutoff = 1.0e-5 }
4011 :    
4012 :     foreach $prot (@$to_try)
4013 :     {
4014 :     if (! $seen->{$prot})
4015 :     {
4016 :     if (($prot =~ /^fig\|(\d+\.\d+)/) && ($1 eq $genome))
4017 :     {
4018 :     $hits->{$prot} = [0,$prot];
4019 :     }
4020 :     else
4021 :     {
4022 :     foreach $sim ($self->sims($prot,1000,$cutoff,"raw",0))
4023 :     {
4024 :     $id2 = $sim->id2;
4025 :     $psc = $sim->psc;
4026 :     foreach $id2a (map { $_->[0] } $self->mapped_prot_ids($id2))
4027 :     {
4028 :     if (($id2a =~ /^fig\|(\d+\.\d+)/) && ($1 eq $genome))
4029 :     {
4030 :     $x = $hits->{$id2a};
4031 :     if ((! $x) || ($x->[0] > $psc))
4032 :     {
4033 :     $hits->{$id2a} = [$sim->psc,$prot];
4034 :     }
4035 :     }
4036 :     elsif ($psc < 1.0e-20)
4037 :     {
4038 :     {
4039 :     $seen->{$id2a} = 1;
4040 :     }
4041 :     }
4042 :     }
4043 :    
4044 :     }
4045 :     }
4046 :     }
4047 :     }
4048 :     }
4049 :    
4050 : overbeek 1.65
4051 :     =pod
4052 :    
4053 :     =head1 best_bbh_candidates
4054 :    
4055 :     usage: @candidates = $fig->best_bbh_candidates($genome,$cutoff,$requested,$known)
4056 :    
4057 :     This routine returns a list of up to $requested candidates from $genome. A candidate is a BBH
4058 :     against one of the PEGs in @$known. Each entry in the list is a 3-tuple:
4059 :    
4060 :     [CandidatePEG,KnownBBH,Pscore]
4061 :    
4062 :     =cut
4063 :    
4064 :     sub best_bbh_candidates {
4065 : overbeek 1.71 my($self,$genome,$cutoff,$requested,$known,$frac_match) = @_;
4066 : overbeek 1.64 my($i,$j,$k,$sim,@sims,$peg,$id2,$genome2,$sim_back);
4067 : overbeek 1.67 my($bbh,%seen,%computed_sims,$genome1);
4068 : overbeek 1.64
4069 : overbeek 1.71 $frac_match = defined($frac_match) ? $frac_match : 0.7;
4070 : overbeek 1.64 my @got = ();
4071 :     my @cand = $self->candidates_for_role_from_known($genome,$cutoff,$known);
4072 :     if (@cand > 0)
4073 :     {
4074 : overbeek 1.67 my %genomes = map { $genome1 = &FIG::genome_of($_); $genome1 => 1 } @$known;
4075 : overbeek 1.64 my %pegs = map { $_ => 1 } @$known;
4076 :     for ($i=0; (@got < $requested) && ($i < @cand); $i++)
4077 :     {
4078 :     $peg = $cand[$i];
4079 :     undef %seen;
4080 :     @sims = grep { $genomes{&FIG::genome_of($_->id2)} } $self->sims($peg,1000,$cutoff,"fig");
4081 :     $bbh = 0;
4082 :     for ($j=0; (! $bbh) && ($j < @sims); $j++)
4083 :     {
4084 :     $sim = $sims[$j];
4085 :     $id2 = $sim->id2;
4086 :     $genome2 = &FIG::genome_of($id2);
4087 :     if (! $seen{$genome2})
4088 :     {
4089 :     if ($pegs{$id2})
4090 :     {
4091 :     if (! defined($sim_back = $computed_sims{$id2}))
4092 :     {
4093 :     my @sims_back = $self->sims($id2,1000,$cutoff,"fig");
4094 :     for ($k=0; ($k < @sims_back) && (&FIG::genome_of($sims_back[$k]->id2) ne $genome); $k++) {}
4095 :     if ($k < @sims_back)
4096 :     {
4097 :     $sim_back = $computed_sims{$id2} = $sims_back[$k];
4098 :     }
4099 :     else
4100 :     {
4101 :     $sim_back = $computed_sims{$id2} = 0;
4102 :     }
4103 :     }
4104 :     if ($sim_back)
4105 :     {
4106 : overbeek 1.71 if ($self->ok_match($sim_back,$frac_match))
4107 : overbeek 1.64 {
4108 : overbeek 1.65 $bbh = [$id2,$sim_back->psc];
4109 : overbeek 1.64 }
4110 :     }
4111 :     }
4112 :     $seen{$genome2} = 1;
4113 :     }
4114 :     }
4115 :    
4116 :     if ($bbh)
4117 :     {
4118 : overbeek 1.65 push(@got,[$peg,@$bbh]);
4119 : overbeek 1.64 }
4120 :     }
4121 :     }
4122 :     return @got;
4123 :     }
4124 :    
4125 :    
4126 :     sub ok_match {
4127 : overbeek 1.71 my($self,$sim,$frac_match) = @_;
4128 : overbeek 1.64
4129 :     my $ln1 = $sim->ln1;
4130 :     my $ln2 = $sim->ln2;
4131 :     my $b1 = $sim->b1;
4132 :     my $e1 = $sim->e1;
4133 :     my $b2 = $sim->b2;
4134 :     my $e2 = $sim->e2;
4135 :    
4136 : overbeek 1.71 return (((($e1 - $b1) / $ln1) >= $frac_match) &&
4137 :     ((($e2 - $b2) / $ln2) >= $frac_match))
4138 :     }
4139 :    
4140 :     sub external_calls {
4141 :     my($self,$pegs) = @_;
4142 : overbeek 1.72 my($peg,$func);
4143 : overbeek 1.71
4144 :     open(TMP,">/tmp/pegs.$$") || die "could not open /tmp/pegs.$$";
4145 :     foreach $peg (@$pegs)
4146 :     {
4147 :     print TMP "$peg\n";
4148 :     }
4149 :     close(TMP);
4150 :     open(TMP,">/tmp/parms.$$") || die "could not open /tmp/parms.$$";
4151 :     print TMP "no_fig\t1\n";
4152 :     close(TMP);
4153 :    
4154 : overbeek 1.72 my %call = map { chop; ($peg,$func) = split(/\t/,$_) }
4155 :     `$FIG_Config::bin/auto_assign /tmp/parms.$$ < /tmp/pegs.$$ 2> /dev/null | $FIG_Config::bin/make_calls`;
4156 : overbeek 1.71 unlink("/tmp/pegs.$$","/tmp/parms.$$");
4157 : overbeek 1.72 return map { $call{$_} ? [$_,$call{$_}] : [$_,"hypothetical protein"] } @$pegs;
4158 : overbeek 1.71 }
4159 :    
4160 :     use SameFunc;
4161 :    
4162 :     sub same_func {
4163 :     my($self,$f1,$f2) = @_;
4164 :    
4165 :     return &SameFunc::same_func($f1,$f2);
4166 : overbeek 1.64 }
4167 :    
4168 : efrank 1.1 ################################# DNA sequence Stuff ####################################
4169 :    
4170 :     =pod
4171 :    
4172 :     =head1 extract_seq
4173 :    
4174 :     usage: $seq = &FIG::extract_seq($contigs,$loc)
4175 :    
4176 :     This is just a little utility routine that I have found convenient. It assumes that
4177 :     $contigs is a hash that contains IDs as keys and sequences as values. $loc must be of the
4178 :     form
4179 :     Contig_Beg_End
4180 :    
4181 :     where Contig is the ID of one of the sequences; Beg and End give the coordinates of the sought
4182 :     subsequence. If Beg > End, it is assumed that you want the reverse complement of the subsequence.
4183 :     This routine plucks out the subsequence for you.
4184 :    
4185 :     =cut
4186 :    
4187 :     sub extract_seq {
4188 :     my($contigs,$loc) = @_;
4189 :     my($contig,$beg,$end,$contig_seq);
4190 :     my($plus,$minus);
4191 :    
4192 :     $plus = $minus = 0;
4193 :     my $strand = "";
4194 :     my @loc = split(/,/,$loc);
4195 :     my @seq = ();
4196 :     foreach $loc (@loc)
4197 :     {
4198 :     if ($loc =~ /^\S+_(\d+)_(\d+)$/)
4199 :     {
4200 :     if ($1 < $2)
4201 :     {
4202 :     $plus++;
4203 :     }
4204 :     elsif ($2 < $1)
4205 :     {
4206 :     $minus++;
4207 :     }
4208 :     }
4209 :     }
4210 :     if ($plus > $minus)
4211 :     {
4212 :     $strand = "+";
4213 :     }
4214 :     elsif ($plus < $minus)
4215 :     {
4216 :     $strand = "-";
4217 :     }
4218 :    
4219 :     foreach $loc (@loc)
4220 :     {
4221 :     if ($loc =~ /^(\S+)_(\d+)_(\d+)$/)
4222 :     {
4223 :     ($contig,$beg,$end) = ($1,$2,$3);
4224 :     if (($beg < $end) || (($beg == $end) && ($strand eq "+")))
4225 :     {
4226 :     $strand = "+";
4227 :     push(@seq,substr($contigs->{$contig},$beg-1,($end+1-$beg)));
4228 :     }
4229 :     else
4230 :     {
4231 :     $strand = "-";
4232 :     push(@seq,&reverse_comp(substr($contigs->{$contig},$end-1,($beg+1-$end))));
4233 :     }
4234 :     }
4235 :     }
4236 :     return join("",@seq);
4237 :     }
4238 :    
4239 :     =pod
4240 :    
4241 :     =head1 contig_ln
4242 :    
4243 :     usage: $n = $fig->contig_ln($genome,$contig)
4244 :    
4245 :     Returns the length of $contig from $genome.
4246 :    
4247 :     =cut
4248 :    
4249 :     sub contig_ln {
4250 :     my($self,$genome,$contig) = @_;
4251 :     my($rdbH,$relational_db_response);
4252 :    
4253 :     $rdbH = $self->db_handle;
4254 :     if (defined($genome) && defined($contig))
4255 :     {
4256 :     if (($relational_db_response = $rdbH->SQL("SELECT len FROM contig_lengths WHERE ( genome = \'$genome\' ) and ( contig = \'$contig\' )")) &&
4257 :    
4258 :     (@$relational_db_response == 1))
4259 :     {
4260 :     return $relational_db_response->[0]->[0];
4261 :     }
4262 :     }
4263 :     return undef;
4264 :     }
4265 :    
4266 :     =pod
4267 :    
4268 :     =head1 dna_seq
4269 :    
4270 :     usage: $seq = dna_seq($genome,@locations)
4271 :    
4272 :     Returns the concatenated subsequences described by the list of locations. Each location
4273 :     must be of the form
4274 :    
4275 :     Contig_Beg_End
4276 :    
4277 :     where Contig must be the ID of a contig for genome $genome. If Beg > End the location
4278 :     describes a stretch of the complementary strand.
4279 :    
4280 :     =cut
4281 :    
4282 :     sub dna_seq {
4283 :     my($self,$genome,@locations) = @_;
4284 :     my(@pieces,$loc,$contig,$beg,$end,$ln,$rdbH);
4285 :    
4286 :     @pieces = ();
4287 :     foreach $loc (@locations)
4288 :     {
4289 :     if ($loc =~ /^(\S+)_(\d+)_(\d+)$/)
4290 :     {
4291 :     ($contig,$beg,$end) = ($1,$2,$3);
4292 :     $ln = $self->contig_ln($genome,$contig);
4293 :    
4294 :     if (! $ln) {
4295 :     print STDERR "$genome/$contig: could not get length\n";
4296 :     return "";
4297 :     }
4298 :    
4299 :     if (&between(1,$beg,$ln) && &between(1,$end,$ln))
4300 :     {
4301 :     if ($beg < $end)
4302 :     {
4303 :     push(@pieces, $self->get_dna($genome,$contig,$beg,$end));
4304 :     }
4305 :     else
4306 :     {
4307 :     push(@pieces, &reverse_comp($self->get_dna($genome,$contig,$end,$beg)));
4308 :     }
4309 :     }
4310 :     }
4311 :     }
4312 :     return join("",@pieces);
4313 :     }
4314 :    
4315 :     sub get_dna {
4316 :     my($self,$genome,$contig,$beg,$end) = @_;
4317 :     my $relational_db_response;
4318 :    
4319 :     my $rdbH = $self->db_handle;
4320 :     my $indexpt = int(($beg-1)/10000) * 10000;
4321 :     if (($relational_db_response = $rdbH->SQL("SELECT startN,fileno,seek FROM contig_seeks WHERE ( genome = \'$genome\' ) AND ( contig = \'$contig\' ) AND ( indexpt = $indexpt )")) &&
4322 :     (@$relational_db_response == 1))
4323 :     {
4324 :     my($startN,$fileN,$seek) = @{$relational_db_response->[0]};
4325 :     my $fh = $self->openF($self->N2file($fileN));
4326 :     if (seek($fh,$seek,0))
4327 :     {
4328 :     my $chunk = "";
4329 :     read($fh,$chunk,int(($end + 1 - $startN) * 1.03));
4330 :     $chunk =~ s/\s//g;
4331 :     my $ln = ($end - $beg) + 1;
4332 :     if (length($chunk) >= $ln)
4333 :     {
4334 :     return substr($chunk,(($beg-1)-$startN),$ln);
4335 :     }
4336 :     }
4337 :     }
4338 :     return undef;
4339 :     }
4340 :    
4341 : overbeek 1.36 ################################# Taxonomy ####################################
4342 :    
4343 :     =pod
4344 :    
4345 :     =head1 taxonomy_of
4346 :    
4347 :     usage: $gs = $fig->taxonomy_of($genome_id)
4348 :    
4349 :     Returns the taxonomy of the specified genome. Gives the taxonomy down to
4350 :     genus and species.
4351 :    
4352 :     =cut
4353 :    
4354 :     sub taxonomy_of {
4355 :     my($self,$genome) = @_;
4356 :     my($ans);
4357 :     my $taxonomy = $self->cached('_taxonomy');
4358 :    
4359 :     if (! ($ans = $taxonomy->{$genome}))
4360 :     {
4361 :     my $rdbH = $self->db_handle;
4362 :     my $relational_db_response = $rdbH->SQL("SELECT genome,taxonomy FROM genome");
4363 :     my $pair;
4364 :     foreach $pair (@$relational_db_response)
4365 :     {
4366 :     $taxonomy->{$pair->[0]} = $pair->[1];
4367 :     }
4368 :     $ans = $taxonomy->{$genome};
4369 :     }
4370 :     return $ans;
4371 :     }
4372 :    
4373 :     =pod
4374 :    
4375 :     =head1 is_bacterial
4376 :    
4377 :     usage: $fig->is_bacterial($genome)
4378 :    
4379 :     Returns true iff the genome is bacterial.
4380 :    
4381 :     =cut
4382 :    
4383 :     sub is_bacterial {
4384 :     my($self,$genome) = @_;
4385 :    
4386 : mkubal 1.53 return ($self->taxonomy_of($genome) =~ /^Bacteria/) ? 1 : 0;
4387 : overbeek 1.36 }
4388 :    
4389 :    
4390 :     =pod
4391 :    
4392 :     =head1 is_archaeal
4393 :    
4394 :     usage: $fig->is_archaeal($genome)
4395 :    
4396 :     Returns true iff the genome is archaeal.
4397 :    
4398 :     =cut
4399 :    
4400 :     sub is_archaeal {
4401 :     my($self,$genome) = @_;
4402 :    
4403 : mkubal 1.53 return ($self->taxonomy_of($genome) =~ /^Archaea/) ? 1 : 0;
4404 : overbeek 1.36 }
4405 :    
4406 :    
4407 :     =pod
4408 :    
4409 :     =head1 is_prokaryotic
4410 :    
4411 :     usage: $fig->is_prokaryotic($genome)
4412 :    
4413 :     Returns true iff the genome is prokaryotic
4414 :    
4415 :     =cut
4416 :    
4417 :     sub is_prokaryotic {
4418 :     my($self,$genome) = @_;
4419 :    
4420 : mkubal 1.53 return ($self->taxonomy_of($genome) =~ /^(Archaea|Bacteria)/) ? 1 : 0;
4421 : overbeek 1.36 }
4422 :    
4423 :    
4424 :     =pod
4425 :    
4426 :     =head1 is_eukaryotic
4427 :    
4428 :     usage: $fig->is_eukaryotic($genome)
4429 :    
4430 :     Returns true iff the genome is eukaryotic
4431 :    
4432 :     =cut
4433 :    
4434 :     sub is_eukaryotic {
4435 :     my($self,$genome) = @_;
4436 :    
4437 : mkubal 1.53 return ($self->taxonomy_of($genome) =~ /^Eukaryota/) ? 1 : 0;
4438 : overbeek 1.36 }
4439 :    
4440 :     =pod
4441 :    
4442 :     =head1 sort_genomes_by_taxonomy
4443 :    
4444 :     usage: @genomes = $fig->sort_genomes_by_taxonomy(@list_of_genomes)
4445 :    
4446 :     This routine is used to sort a list of genome IDs to put them
4447 :     into taxonomic order.
4448 :    
4449 :     =cut
4450 :    
4451 :     sub sort_genomes_by_taxonomy {
4452 :     my($self,@fids) = @_;
4453 :    
4454 :     return map { $_->[0] }
4455 :     sort { $a->[1] cmp $b->[1] }
4456 :     map { [$_,$self->taxonomy_of($_)] }
4457 :     @fids;
4458 :     }
4459 :    
4460 :     =pod
4461 :    
4462 :     =head1 crude_estimate_of_distance
4463 :    
4464 :     usage: $dist = $fig->crude_estimate_of_distance($genome1,$genome2)
4465 :    
4466 :     There are a number of places where we need estimates of the distance between
4467 :     two genomes. This routine will return a value between 0 and 1, where a value of 0
4468 :     means "the genomes are essentially identical" and a value of 1 means
4469 :     "the genomes are in different major groupings" (the groupings are archaea, bacteria,
4470 :     euks, and viruses). The measure is extremely crude.
4471 :    
4472 :     =cut
4473 :    
4474 :     sub crude_estimate_of_distance {
4475 :     my($self,$genome1,$genome2) = @_;
4476 :     my($i,$v,$d,$dist);
4477 :    
4478 :     if ($genome1 > $genome2) { ($genome1,$genome2) = ($genome2,$genome1) }
4479 :    
4480 :     my $relational_db_response;
4481 :     my $rdbH = $self->db_handle;
4482 :    
4483 :     if (($relational_db_response = $rdbH->SQL("SELECT dist FROM distances WHERE ( genome1 = \'$genome1\' ) AND ( genome2 = \'$genome2\' ) ")) &&
4484 :     (@$relational_db_response == 1))
4485 :     {
4486 :     return $relational_db_response->[0]->[0];
4487 :     }
4488 :     return $self->crude_estimate_of_distance1($genome1,$genome2);
4489 :     }
4490 :    
4491 :     sub crude_estimate_of_distance1 {
4492 :     my($self,$genome1,$genome2) = @_;
4493 :     my($i,$v,$d,$dist);
4494 :    
4495 :     if ($genome1 > $genome2) { ($genome1,$genome2) = ($genome2,$genome1) }
4496 :     $dist = $self->cached('_dist');
4497 :     if (! $dist->{"$genome1,$genome2"})
4498 :     {
4499 :     my @tax1 = split(/\s*;\s*/,$self->taxonomy_of($genome1));
4500 :     my @tax2 = split(/\s*;\s*/,$self->taxonomy_of($genome2));
4501 :    
4502 :     $d = 1;
4503 :     for ($i=0, $v=0.5; ($i < @tax1) && ($i < @tax2) && ($tax1[$i] eq $tax2[$i]); $i++, $v = $v/2)
4504 :     {
4505 :     $d -= $v;
4506 :     }
4507 :     $dist->{"$genome1,$genome2"} = $d;
4508 :     }
4509 :     return $dist->{"$genome1,$genome2"};
4510 :     }
4511 :    
4512 :     =pod
4513 :    
4514 :     =head1 sort_fids_by_taxonomy
4515 :    
4516 :     usage: @sorted_by_taxonomy = $fig->sort_fids_by_taxonomy(@list_of_fids)
4517 :    
4518 :     Sorts a list of feature IDs based on the taxonomies of the genomes that contain the features.
4519 :    
4520 :     =cut
4521 :    
4522 :     sub sort_fids_by_taxonomy {
4523 :     my($self,@fids) = @_;
4524 :    
4525 :     return map { $_->[0] }
4526 :     sort { $a->[1] cmp $b->[1] }
4527 :     map { [$_,$self->taxonomy_of(&genome_of($_))] }
4528 :     @fids;
4529 :     }
4530 :    
4531 :     sub build_tree_of_complete {
4532 :     my($self,$min_for_label) = @_;
4533 :     my(@last,@tax,$i,$prefix,$lev,$genome,$tax);
4534 :    
4535 :     $min_for_label = $min_for_label ? $min_for_label : 10;
4536 :     open(TMP,">/tmp/tree$$") || die "could not open /tmp/tree$$";
4537 :     print TMP "1. root\n";
4538 :    
4539 :     @last = ();
4540 :    
4541 :    
4542 :     foreach $genome (grep { $_ !~ /^99999/ } $self->sort_genomes_by_taxonomy($self->genomes("complete")))
4543 :     {
4544 :     $tax = $self->taxonomy_of($genome);
4545 :     @tax = split(/\s*;\s*/,$tax);
4546 :     push(@tax,$genome);
4547 :     for ($i=0; ((@last > $i) && (@tax > $i) && ($last[$i] eq $tax[$i])); $i++) {}
4548 :     while ($i < @tax)
4549 :     {
4550 :     $lev = $i+2;
4551 :     $prefix = " " x (4 * ($lev-1));
4552 :     print TMP "$prefix$lev\. $tax[$i]\n";
4553 :     $i++;
4554 :     }
4555 :     @last = @tax;
4556 :     }
4557 :     close(TMP);
4558 :     my $tree = &tree_utilities::build_tree_from_outline("/tmp/tree$$");
4559 :     $tree->[0] = 'All';
4560 :     &limit_labels($tree,$min_for_label);
4561 :     unlink("/tmp/tree$$");
4562 :     return ($tree,&tips_of_tree($tree));
4563 :     }
4564 :    
4565 :     sub limit_labels {
4566 :     my($tree,$min_for_label) = @_;
4567 :    
4568 :     my($children) = &tree_utilities::node_pointers($tree);
4569 :     if (@$children == 1)
4570 :     {
4571 :     return 1;
4572 :     }
4573 :     else
4574 :     {
4575 :     my $n = 0;
4576 :     my $i;
4577 :     for ($i=1; ($i < @$children); $i++)
4578 :     {
4579 :     $n += &limit_labels($children->[$i],$min_for_label);
4580 :     }
4581 :     if ($n < $min_for_label)
4582 :     {
4583 :     $tree->[0] = "";
4584 :     }
4585 :     return $n;
4586 :     }
4587 :     }
4588 :    
4589 :     sub taxonomic_groups_of_complete {
4590 :     my($self,$min_for_labels) = @_;
4591 :    
4592 :     my($tree,undef) = $self->build_tree_of_complete($min_for_labels);
4593 :     return &taxonomic_groups($tree);
4594 :     }
4595 :    
4596 :     sub taxonomic_groups {
4597 :     my($tree) = @_;
4598 :    
4599 :     my($groups,undef) = &taxonomic_groups_and_children($tree);
4600 :     return $groups;
4601 :     }
4602 :    
4603 :     sub taxonomic_groups_and_children {
4604 :     my($tree) = @_;
4605 :     my($ids1,$i,$groupsC,$idsC);
4606 :    
4607 :     my $ptrs = &tree_utilities::node_pointers($tree);
4608 :     my $ids = [];
4609 :     my $groups = [];
4610 :    
4611 :     if (@$ptrs > 1)
4612 :     {
4613 :     $ids1 = [];
4614 :     for ($i=1; ($i < @$ptrs); $i++)
4615 :     {
4616 :     ($groupsC,$idsC) = &taxonomic_groups_and_children($ptrs->[$i]);
4617 :     if (@$groupsC > 0)
4618 :     {
4619 :     push(@$groups,@$groupsC);
4620 :     }
4621 :     push(@$ids1,@$idsC);
4622 :     }
4623 :    
4624 :     if ($tree->[0])
4625 :     {
4626 :     push(@$groups,[$tree->[0],$ids1]);
4627 :     }
4628 :     push(@$ids,@$ids1);
4629 :     }
4630 :     elsif ($tree->[0])
4631 :     {
4632 :     push(@$ids,$tree->[0]);
4633 :     }
4634 :    
4635 :     return ($groups,$ids);
4636 :     }
4637 :    
4638 : overbeek 1.39 ################################# Subsystems ####################################
4639 :    
4640 :     sub exportable_subsystem {
4641 :     my($self,$ssa) = @_;
4642 :     my(%seqs,@genomes);
4643 :    
4644 :     my $spreadsheet = [];
4645 :     my $notes = [];
4646 :    
4647 :     $ssa =~ s/ /_/g;
4648 :     if (open(SSA,"<$FIG_Config::data/Subsystems/$ssa/spreadsheet"))
4649 :     {
4650 : overbeek 1.42 my $version = $self->subsystem_version($ssa);
4651 :     my $exchangable = $self->is_exchangable_subsystem($ssa);
4652 : overbeek 1.49 push(@$spreadsheet,"$ssa\n$version\n$exchangable\n");
4653 :     my @curation = `head -1 $FIG_Config::data/Subsystems/$ssa/curation.log`;
4654 :     push(@$spreadsheet,$curation[0],"//\n");
4655 : overbeek 1.42
4656 : overbeek 1.39 while (defined($_ = <SSA>) && ($_ !~ /^\/\//))
4657 :     {
4658 :     push(@$spreadsheet,$_);
4659 :     }
4660 :     push(@$spreadsheet,"//\n");
4661 :    
4662 :     while (defined($_ = <SSA>) && ($_ !~ /^\/\//))
4663 :     {
4664 :     push(@$spreadsheet,$_);
4665 :     }
4666 :     push(@$spreadsheet,"//\n");
4667 :    
4668 :     while (defined($_ = <SSA>))
4669 :     {
4670 :     push(@$spreadsheet,$_);
4671 : golsen 1.44 chomp;
4672 : overbeek 1.39 my @flds = split(/\t/,$_);
4673 :     my $genome = $flds[0];
4674 :     push(@genomes,$genome);
4675 :     my($i,$id);
4676 :     for ($i=2; ($i < @flds); $i++)
4677 :     {
4678 :     if ($flds[$i])
4679 :     {
4680 :     my @entries = split(/,/,$flds[$i]);
4681 :     foreach $id (@entries)
4682 :     {
4683 :     $seqs{"fig\|$genome\.peg.$id"} = 1;
4684 :     }
4685 :     }
4686 :     }
4687 :     }
4688 :     push(@$spreadsheet,"//\n");
4689 :    
4690 :     my $peg;
4691 :     foreach $peg (sort { &FIG::by_fig_id($a,$b) } keys(%seqs))
4692 :     {
4693 :     my @aliases = grep { $_ =~ /^(sp\||gi\||pirnr\||kegg\||N[PGZ]_)/ } $self->feature_aliases($peg);
4694 :     push(@$spreadsheet,join("\t",($peg,join(",",@aliases),$self->genus_species($self->genome_of($peg)),scalar $self->function_of($peg))) . "\n");
4695 :     }
4696 :     push(@$spreadsheet,"//\n");
4697 :    
4698 :     foreach $peg (sort { &FIG::by_fig_id($a,$b) } keys(%seqs))
4699 :     {
4700 :     my $aliases = $self->feature_aliases($peg);
4701 :     my $seq = $self->get_translation($peg);
4702 :     push(@$spreadsheet,">$peg $aliases\n");
4703 :     my($i,$ln);
4704 :     $ln = length($seq);
4705 :     for ($i=0; ($i < $ln); $i += 60)
4706 :     {
4707 :     if (($ln - $i) > 60)
4708 :     {
4709 :