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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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