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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.100 - (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.98 if (@fxs >= 50)
1121 : efrank 1.1 {
1122 :     @fxs = sort { $fxs->{$a}->[1] <=> $fxs->{$b}->[1] } @fxs;
1123 :     $x = $fxs->{$fxs[0]};
1124 :     undef $x->[0];
1125 :     delete $fxs->{$fxs[0]};
1126 :     }
1127 :     $fxs->{$file} = [$fh,time()];
1128 :     return $fh;
1129 :     }
1130 :     return undef;
1131 :     }
1132 :    
1133 :     #=pod
1134 :     #
1135 :     #=head1 closeF
1136 :     #
1137 :     #usage: $fig->closeF($filename)
1138 :     #
1139 :     #Parts of the system rely on accessing numerous different files. The most obvious case is
1140 :     #the situation with similarities. It is important that the system be able to run in cases in
1141 :     #which an arbitrary number of files cannot be open simultaneously. This routine (with openF) is
1142 :     #a hack to handle this. I should probably just pitch them and insist that the OS handle several
1143 :     #hundred open filehandles.
1144 :     #
1145 :     #=cut
1146 :     #
1147 :     sub closeF {
1148 :     my($self,$file) = @_;
1149 :     my($fxs,$x);
1150 :    
1151 :     if (($fxs = $self->{_openF}) &&
1152 :     ($x = $fxs->{$file}))
1153 :     {
1154 :     undef $x->[0];
1155 :     delete $fxs->{$file};
1156 :     }
1157 :     }
1158 :    
1159 :     =pod
1160 :    
1161 :     =head1 ec_name
1162 :    
1163 :     usage: $enzymatic_function = $fig->ec_name($ec)
1164 :    
1165 :     Returns enzymatic name for EC.
1166 :    
1167 :     =cut
1168 :    
1169 :     sub ec_name {
1170 :     my($self,$ec) = @_;
1171 :    
1172 :     ($ec =~ /^\d+\.\d+\.\d+\.\d+$/) || return "";
1173 :     my $rdbH = $self->db_handle;
1174 :     my $relational_db_response = $rdbH->SQL("SELECT name FROM ec_names WHERE ( ec = \'$ec\' )");
1175 :    
1176 :     return (@$relational_db_response == 1) ? $relational_db_response->[0]->[0] : "";
1177 :     return "";
1178 :     }
1179 :    
1180 :     =pod
1181 :    
1182 :     =head1 all_roles
1183 :    
1184 :     usage: @roles = $fig->all_roles
1185 :    
1186 : mkubal 1.54 Supposed to return all known roles. For now, we get all ECs with "names".
1187 : efrank 1.1
1188 :     =cut
1189 :    
1190 :     sub all_roles {
1191 :     my($self) = @_;
1192 :    
1193 :     my $rdbH = $self->db_handle;
1194 :     my $relational_db_response = $rdbH->SQL("SELECT ec,name FROM ec_names");
1195 :    
1196 :     return @$relational_db_response;
1197 :     }
1198 :    
1199 :     =pod
1200 :    
1201 :     =head1 expand_ec
1202 :    
1203 :     usage: $expanded_ec = $fig->expand_ec($ec)
1204 :    
1205 :     Expands "1.1.1.1" to "1.1.1.1 - alcohol dehydrogenase" or something like that.
1206 :    
1207 :     =cut
1208 :    
1209 :     sub expand_ec {
1210 :     my($self,$ec) = @_;
1211 :     my($name);
1212 :    
1213 :     return ($name = $self->ec_name($ec)) ? "$ec - $name" : $ec;
1214 :     }
1215 :    
1216 :    
1217 :     =pod
1218 :    
1219 :     =head1 clean_tmp
1220 :    
1221 :     usage: &FIG::clean_tmp
1222 :    
1223 :     We store temporary files in $FIG_Config::temp. There are specific classes of files
1224 :     that are created and should be saved for at least a few days. This routine can be
1225 :     invoked to clean out those that are over two days old.
1226 :    
1227 :     =cut
1228 :    
1229 :     sub clean_tmp {
1230 :    
1231 :     my($file);
1232 :     if (opendir(TMP,"$FIG_Config::temp"))
1233 :     {
1234 :     # change the pattern to pick up other files that need to be cleaned up
1235 :     my @temp = grep { $_ =~ /^(Geno|tmp)/ } readdir(TMP);
1236 :     foreach $file (@temp)
1237 :     {
1238 :     if (-M "$FIG_Config::temp/$file" > 2)
1239 :     {
1240 :     unlink("$FIG_Config::temp/$file");
1241 :     }
1242 :     }
1243 :     }
1244 :     }
1245 :    
1246 :     ################ Routines to process genomes and genome IDs ##########################
1247 :    
1248 :    
1249 :     =pod
1250 :    
1251 :     =head1 genomes
1252 :    
1253 :     usage: @genome_ids = $fig->genomes;
1254 :    
1255 :     Genomes are assigned ids of the form X.Y where X is the taxonomic id maintained by
1256 :     NCBI for the species (not the specific strain), and Y is a sequence digit assigned to
1257 :     this particular genome (as one of a set with the same genus/species). Genomes also
1258 :     have versions, but that is a separate issue.
1259 :    
1260 :     =cut
1261 :    
1262 :     sub genomes {
1263 : overbeek 1.13 my($self,$complete,$restrictions) = @_;
1264 :    
1265 :     my $rdbH = $self->db_handle;
1266 :    
1267 :     my @where = ();
1268 :     if ($complete)
1269 :     {
1270 :     push(@where,"( complete = \'1\' )")
1271 :     }
1272 :    
1273 :     if ($restrictions)
1274 :     {
1275 :     push(@where,"( restrictions = \'1\' )")
1276 :     }
1277 :    
1278 :     my $relational_db_response;
1279 :     if (@where > 0)
1280 :     {
1281 :     my $where = join(" AND ",@where);
1282 :     $relational_db_response = $rdbH->SQL("SELECT genome FROM genome where $where");
1283 :     }
1284 :     else
1285 :     {
1286 :     $relational_db_response = $rdbH->SQL("SELECT genome FROM genome");
1287 :     }
1288 :     my @genomes = sort { $a <=> $b } map { $_->[0] } @$relational_db_response;
1289 : efrank 1.1 return @genomes;
1290 :     }
1291 :    
1292 : efrank 1.2 sub genome_counts {
1293 : overbeek 1.13 my($self,$complete) = @_;
1294 :     my($x,$relational_db_response);
1295 : efrank 1.2
1296 : overbeek 1.13 my $rdbH = $self->db_handle;
1297 :    
1298 :     if ($complete)
1299 :     {
1300 :     $relational_db_response = $rdbH->SQL("SELECT genome,maindomain FROM genome where complete = '1'");
1301 :     }
1302 :     else
1303 :     {
1304 :     $relational_db_response = $rdbH->SQL("SELECT genome,maindomain FROM genome");
1305 :     }
1306 :    
1307 :     my ($a,$b,$e,$v) = (0,0,0,0);
1308 :     if (@$relational_db_response > 0)
1309 : efrank 1.2 {
1310 : overbeek 1.13 foreach $x (@$relational_db_response)
1311 : efrank 1.2 {
1312 : overbeek 1.13 if ($x->[1] =~ /^a/i) { $a++ }
1313 :     elsif ($x->[1] =~ /^b/i) { $b++ }
1314 :     elsif ($x->[1] =~ /^e/i) { $e++ }
1315 :     elsif ($x->[1] =~ /^v/i) { $v++ }
1316 : efrank 1.2 }
1317 :     }
1318 : overbeek 1.13
1319 : efrank 1.2 return ($a,$b,$e,$v);
1320 :     }
1321 :    
1322 : gdpusch 1.92
1323 :     =pod
1324 :    
1325 :     =head1 genome_pegs
1326 :    
1327 :     usage: $pegs = $fig->genome_pegs($genome_id);
1328 :    
1329 :     Returns the number of DNA base-pairs in the genome contigs file(s) if
1330 :     "$genome_id" is in the "genome" database, and 'undef' otherwise.
1331 :    
1332 :     =cut
1333 :    
1334 :     sub genome_pegs {
1335 :     my($self,$genome) = @_;
1336 :     my $relational_db_response;
1337 :     my $rdbH = $self->db_handle;
1338 :    
1339 :     if ($genome)
1340 :     {
1341 :     if (($relational_db_response = $rdbH->SQL("SELECT pegs FROM genome WHERE ( genome = \'$genome\' )"))
1342 :     && (@$relational_db_response == 1))
1343 :     {
1344 :     return $relational_db_response->[0]->[0];
1345 :     }
1346 :     }
1347 :     return undef;
1348 :     }
1349 :    
1350 :    
1351 : efrank 1.1 =pod
1352 :    
1353 : gdpusch 1.92 =head1 genome_rnas
1354 :    
1355 :     usage: $rnas = $fig->genome_rnas($genome_id);
1356 :    
1357 :     Returns the number of DNA base-pairs in the genome contigs file(s) if
1358 :     "$genome_id" is in the "genome" database, and 'undef' otherwise.
1359 :    
1360 :     =cut
1361 :    
1362 :     sub genome_rnas {
1363 :     my($self,$genome) = @_;
1364 :     my $relational_db_response;
1365 :     my $rdbH = $self->db_handle;
1366 :    
1367 :     if ($genome)
1368 :     {
1369 :     if (($relational_db_response = $rdbH->SQL("SELECT rnas FROM genome WHERE ( genome = \'$genome\' )"))
1370 :     && (@$relational_db_response == 1))
1371 :     {
1372 :     return $relational_db_response->[0]->[0];
1373 :     }
1374 :     }
1375 :     return undef;
1376 :     }
1377 :    
1378 :    
1379 :     =pod
1380 :    
1381 :     =head1 genome_szdna
1382 : efrank 1.1
1383 : gdpusch 1.92 usage: $szdna = $fig->genome_szdna($genome_id);
1384 : gdpusch 1.91
1385 :     Returns the number of DNA base-pairs in the genome contigs file(s) if
1386 :     "$genome_id" is in the "genome" database, and 'undef' otherwise.
1387 :    
1388 :     =cut
1389 :    
1390 : gdpusch 1.92 sub genome_szdna {
1391 : gdpusch 1.91 my($self,$genome) = @_;
1392 :     my $relational_db_response;
1393 :     my $rdbH = $self->db_handle;
1394 :    
1395 :     if ($genome)
1396 :     {
1397 :     if (($relational_db_response = $rdbH->SQL("SELECT szdna FROM genome WHERE ( genome = \'$genome\' )"))
1398 :     && (@$relational_db_response == 1))
1399 :     {
1400 :     return $relational_db_response->[0]->[0];
1401 :     }
1402 :     }
1403 :     return undef;
1404 :     }
1405 :    
1406 :    
1407 :     =pod
1408 :    
1409 :     =head1 genome_version
1410 :    
1411 : efrank 1.1 usage: $version = $fig->genome_version($genome_id);
1412 :    
1413 :     Versions are incremented for major updates. They are put in as major
1414 :     updates of the form 1.0, 2.0, ...
1415 :    
1416 :     Users may do local "editing" of the DNA for a genome, but when they do,
1417 :     they increment the digits to the right of the decimal. Two genomes remain
1418 :     comparable only if the versions match identically. Hence, minor updating should be
1419 :     committed only by the person/group responsible for updating that genome.
1420 :    
1421 :     We can, of course, identify which genes are identical between any two genomes (by matching
1422 :     the DNA or amino acid sequences). However, the basic intent of the system is to
1423 :     support editing by the main group issuing periodic major updates.
1424 :    
1425 :     =cut
1426 :    
1427 :     sub genome_version {
1428 :     my($self,$genome) = @_;
1429 :    
1430 :     my(@tmp);
1431 :     if ((-s "$FIG_Config::organisms/$genome/VERSION") &&
1432 :     (@tmp = `cat $FIG_Config::organisms/$genome/VERSION`) &&
1433 : overbeek 1.84 ($tmp[0] =~ /^(\S+)$/))
1434 : efrank 1.1 {
1435 :     return $1;
1436 :     }
1437 :     return undef;
1438 :     }
1439 :    
1440 :     =pod
1441 :    
1442 :     =head1 genus_species
1443 :    
1444 :     usage: $gs = $fig->genus_species($genome_id)
1445 :    
1446 :     Returns the genus and species (and strain if that has been properly recorded)
1447 :     in a printable form.
1448 :    
1449 :     =cut
1450 :    
1451 :     sub genus_species {
1452 :     my ($self,$genome) = @_;
1453 : overbeek 1.13 my $ans;
1454 : efrank 1.1
1455 :     my $genus_species = $self->cached('_genus_species');
1456 :     if (! ($ans = $genus_species->{$genome}))
1457 :     {
1458 : overbeek 1.13 my $rdbH = $self->db_handle;
1459 :     my $relational_db_response = $rdbH->SQL("SELECT genome,gname FROM genome");
1460 :     my $pair;
1461 :     foreach $pair (@$relational_db_response)
1462 : efrank 1.1 {
1463 : overbeek 1.13 $genus_species->{$pair->[0]} = $pair->[1];
1464 : efrank 1.1 }
1465 : overbeek 1.13 $ans = $genus_species->{$genome};
1466 : efrank 1.1 }
1467 :     return $ans;
1468 :     }
1469 :    
1470 :     =pod
1471 :    
1472 :     =head1 org_of
1473 :    
1474 :     usage: $org = $fig->org_of($prot_id)
1475 :    
1476 :     In the case of external proteins, we can usually determine an organism, but not
1477 :     anything more precise than genus/species (and often not that). This routine takes
1478 : efrank 1.2 a protein ID (which may be a feature ID) and returns "the organism".
1479 : efrank 1.1
1480 :     =cut
1481 :    
1482 :     sub org_of {
1483 :     my($self,$prot_id) = @_;
1484 :     my $relational_db_response;
1485 :     my $rdbH = $self->db_handle;
1486 :    
1487 :     if ($prot_id =~ /^fig\|/)
1488 :     {
1489 :     return $self->genus_species($self->genome_of($prot_id));
1490 :     }
1491 :    
1492 :     if (($relational_db_response = $rdbH->SQL("SELECT org FROM external_orgs WHERE ( prot = \'$prot_id\' )")) &&
1493 :     (@$relational_db_response >= 1))
1494 :     {
1495 :     return $relational_db_response->[0]->[0];
1496 :     }
1497 :     return "";
1498 :     }
1499 :    
1500 :     =pod
1501 :    
1502 :     =head1 abbrev
1503 :    
1504 :     usage: $abbreviated_name = $fig->abbrev($genome_name)
1505 :    
1506 :     For alignments and such, it is very useful to be able to produce an abbreviation of genus/species.
1507 :     That's what this does. Note that multiple genus/species might reduce to the same abbreviation, so
1508 :     be careful (disambiguate them, if you must).
1509 :    
1510 :     =cut
1511 :    
1512 :     sub abbrev {
1513 :     my($genome_name) = @_;
1514 :    
1515 :     $genome_name =~ s/^(\S{3})\S+/$1./;
1516 :     $genome_name =~ s/^(\S+\s+\S{4})\S+/$1./;
1517 :     if (length($genome_name) > 13)
1518 :     {
1519 :     $genome_name = substr($genome_name,0,13);
1520 :     }
1521 :     return $genome_name;
1522 :     }
1523 :    
1524 :     ################ Routines to process Features and Feature IDs ##########################
1525 :    
1526 :     =pod
1527 :    
1528 :     =head1 ftype
1529 :    
1530 :     usage: $type = &FIG::ftype($fid)
1531 :    
1532 :     Returns the type of a feature, given the feature ID. This just amounts
1533 :     to lifting it out of the feature ID, since features have IDs of tghe form
1534 :    
1535 :     fig|x.y.f.n
1536 :    
1537 :     where
1538 :     x.y is the genome ID
1539 :     f is the type pf feature
1540 :     n is an integer that is unique within the genome/type
1541 :    
1542 :     =cut
1543 :    
1544 :     sub ftype {
1545 :     my($feature_id) = @_;
1546 :    
1547 :     if ($feature_id =~ /^fig\|\d+\.\d+\.([^\.]+)/)
1548 :     {
1549 :     return $1;
1550 :     }
1551 :     return undef;
1552 :     }
1553 :    
1554 :     =pod
1555 :    
1556 :     =head1 genome_of
1557 :    
1558 :     usage: $genome_id = $fig->genome_of($fid)
1559 :    
1560 :     This just extracts the genome ID from a feature ID.
1561 :    
1562 :     =cut
1563 :    
1564 :    
1565 :     sub genome_of {
1566 :     my $prot_id = (@_ == 1) ? $_[0] : $_[1];
1567 :    
1568 :     if ($prot_id =~ /^fig\|(\d+\.\d+)/) { return $1; }
1569 :     return undef;
1570 :     }
1571 :    
1572 : olson 1.96 =head1 genome_and_peg_of
1573 :    
1574 :     usage: ($genome_id, $peg_number = $fig->genome_and_peg_of($fid)
1575 :    
1576 :     This just extracts the genome ID and peg number from a feature ID.
1577 :    
1578 :     =cut
1579 :    
1580 :    
1581 :     sub genome_and_peg_of {
1582 :     my $prot_id = (@_ == 1) ? $_[0] : $_[1];
1583 :    
1584 :     if ($prot_id =~ /^fig\|(\d+\.\d+)\.peg\.(\d+)/)
1585 :     {
1586 :     return ($1, $2);
1587 :     }
1588 :     return undef;
1589 :     }
1590 :    
1591 : efrank 1.1 =pod
1592 :    
1593 :     =head1 by_fig_id
1594 :    
1595 :     usage: @sorted_by_fig_id = sort { &FIG::by_fig_id($a,$b) } @fig_ids
1596 :    
1597 :     This is a bit of a clutzy way to sort a list of FIG feature IDs, but it works.
1598 :    
1599 :     =cut
1600 :    
1601 :     sub by_fig_id {
1602 :     my($a,$b) = @_;
1603 :     my($g1,$g2,$t1,$t2,$n1,$n2);
1604 :     if (($a =~ /^fig\|(\d+\.\d+).([^\.]+)\.(\d+)$/) && (($g1,$t1,$n1) = ($1,$2,$3)) &&
1605 :     ($b =~ /^fig\|(\d+\.\d+).([^\.]+)\.(\d+)$/) && (($g2,$t2,$n2) = ($1,$2,$3)))
1606 :     {
1607 :     ($g1 <=> $g2) or ($t1 cmp $t2) or ($n1 <=> $n2);
1608 :     }
1609 :     else
1610 :     {
1611 :     $a cmp $b;
1612 :     }
1613 :     }
1614 :    
1615 :     =pod
1616 :    
1617 :     =head1 genes_in_region
1618 :    
1619 :     usage: ($features_in_region,$beg1,$end1) = $fig->genes_in_region($genome,$contig,$beg,$end)
1620 :    
1621 :     It is often important to be able to find the genes that occur in a specific region on
1622 :     a chromosome. This routine is designed to provide this information. It returns all genes
1623 :     that overlap the region ($genome,$contig,$beg,$end). $beg1 is set to the minimum coordinate of
1624 :     the returned genes (which may be before the given region), and $end1 the maximum coordinate.
1625 :    
1626 :     The routine assumes that genes are not more than 10000 bases long, which is certainly not true
1627 :     in eukaryotes. Hence, in euks you may well miss genes that overlap the boundaries of the specified
1628 :     region (sorry).
1629 :    
1630 :     =cut
1631 :    
1632 :    
1633 :     sub genes_in_region {
1634 :     my($self,$genome,$contig,$beg,$end) = @_;
1635 :     my($x,$relational_db_response,$feature_id,$b1,$e1,@feat,@tmp,$l,$u);
1636 :    
1637 :     my $pad = 10000;
1638 :     my $rdbH = $self->db_handle;
1639 :    
1640 :     my $minV = $beg - $pad;
1641 :     my $maxV = $end + $pad;
1642 :     if (($relational_db_response = $rdbH->SQL("SELECT id FROM features
1643 :     WHERE ( minloc > $minV ) AND ( minloc < $maxV ) AND (maxloc < $maxV) AND
1644 :     ( genome = \'$genome\' ) AND ( contig = \'$contig\' );")) &&
1645 :     (@$relational_db_response >= 1))
1646 :     {
1647 :     @tmp = sort { ($a->[1] cmp $b->[1]) or
1648 :     ($a->[2] <=> $b->[2]) or
1649 :     ($a->[3] <=> $b->[3])
1650 :     }
1651 :     map { $feature_id = $_->[0];
1652 :     $x = $self->feature_location($feature_id);
1653 :     $x ? [$feature_id,&boundaries_of($x)] : ()
1654 :     } @$relational_db_response;
1655 :    
1656 :    
1657 :     ($l,$u) = (10000000000,0);
1658 :     foreach $x (@tmp)
1659 :     {
1660 :     ($feature_id,undef,$b1,$e1) = @$x;
1661 :     if (&between($beg,&min($b1,$e1),$end) || &between(&min($b1,$e1),$beg,&max($b1,$e1)))
1662 :     {
1663 :     push(@feat,$feature_id);
1664 :     $l = &min($l,&min($b1,$e1));
1665 :     $u = &max($u,&max($b1,$e1));
1666 :     }
1667 :     }
1668 :     (@feat <= 0) || return ([@feat],$l,$u);
1669 :     }
1670 :     return ([],$l,$u);
1671 :     }
1672 :    
1673 :     sub close_genes {
1674 :     my($self,$fid,$dist) = @_;
1675 :    
1676 :     my $loc = $self->feature_location($fid);
1677 :     if ($loc)
1678 :     {
1679 :     my($contig,$beg,$end) = &FIG::boundaries_of($loc);
1680 :     if ($contig && $beg && $end)
1681 :     {
1682 :     my $min = &min($beg,$end) - $dist;
1683 :     my $max = &max($beg,$end) + $dist;
1684 :     my $feat;
1685 :     ($feat,undef,undef) = $self->genes_in_region(&FIG::genome_of($fid),$contig,$min,$max);
1686 :     return @$feat;
1687 :     }
1688 :     }
1689 :     return ();
1690 :     }
1691 :    
1692 :    
1693 :     =pod
1694 :    
1695 :     =head1 feature_location
1696 :    
1697 :     usage: $loc = $fig->feature_location($fid) OR
1698 :     @loc = $fig->feature_location($fid)
1699 :    
1700 :     The location of a feature in a scalar context is
1701 :    
1702 :     contig_b1_e1,contig_b2_e2,... [one contig_b_e for each exon]
1703 :    
1704 :     In a list context it is
1705 :    
1706 :     (contig_b1_e1,contig_b2_e2,...)
1707 :    
1708 :     =cut
1709 :    
1710 :     sub feature_location {
1711 :     my($self,$feature_id) = @_;
1712 :     my($relational_db_response,$locations,$location);
1713 :    
1714 :     $locations = $self->cached('_location');
1715 :     if (! ($location = $locations->{$feature_id}))
1716 :     {
1717 :     my $rdbH = $self->db_handle;
1718 :     if (($relational_db_response = $rdbH->SQL("SELECT location FROM features WHERE ( id = \'$feature_id\' )")) &&
1719 :     (@$relational_db_response == 1))
1720 :     {
1721 :     $locations->{$feature_id} = $location = $relational_db_response->[0]->[0];
1722 :     }
1723 :     }
1724 :    
1725 :     if ($location)
1726 :     {
1727 :     return wantarray() ? split(/,/,$location) : $location;
1728 :     }
1729 :     return undef;
1730 :     }
1731 :    
1732 :     =pod
1733 :    
1734 :     =head1 boundaries_of
1735 :    
1736 :     usage: ($contig,$beg,$end) = $fig->boundaries_of($loc)
1737 :    
1738 :     The location of a feature in a scalar context is
1739 :    
1740 :     contig_b1_e1,contig_b2_e2,... [one contig_b_e for each exon]
1741 :    
1742 :     This routine takes as input such a location and reduces it to a single
1743 :     description of the entire region containing the gene.
1744 :    
1745 :     =cut
1746 :    
1747 :     sub boundaries_of {
1748 :     my($location) = (@_ == 1) ? $_[0] : $_[1];
1749 :     my($contigQ);
1750 :    
1751 :     if (defined($location))
1752 :     {
1753 :     my @exons = split(/,/,$location);
1754 :     my($contig,$beg,$end);
1755 :     if (($exons[0] =~ /^(\S+)_(\d+)_\d+$/) &&
1756 :     (($contig,$beg) = ($1,$2)) && ($contigQ = quotemeta $contig) &&
1757 :     ($exons[$#exons] =~ /^$contigQ\_\d+_(\d+)$/) &&
1758 :     ($end = $1))
1759 :     {
1760 :     return ($contig,$beg,$end);
1761 :     }
1762 :     }
1763 :     return undef;
1764 :     }
1765 :    
1766 :    
1767 :     =pod
1768 :    
1769 :     =head1 all_features
1770 :    
1771 :     usage: $fig->all_features($genome,$type)
1772 :    
1773 :     Returns a list of all feature IDs of a specified type in the designated genome. You would
1774 :     usually use just
1775 :    
1776 :     $fig->pegs_of($genome) or
1777 :     $fig->rnas_of($genome)
1778 :    
1779 :     which simply invoke this routine.
1780 :    
1781 :     =cut
1782 :    
1783 :     sub all_features {
1784 :     my($self,$genome,$type) = @_;
1785 :    
1786 :     my $rdbH = $self->db_handle;
1787 :     my $relational_db_response = $rdbH->SQL("SELECT id FROM features WHERE (genome = \'$genome\' AND (type = \'$type\'))");
1788 :    
1789 :     if (@$relational_db_response > 0)
1790 :     {
1791 :     return map { $_->[0] } @$relational_db_response;
1792 :     }
1793 :     return ();
1794 :     }
1795 :    
1796 :    
1797 :     =pod
1798 :    
1799 :     =head1 all_pegs_of
1800 :    
1801 :     usage: $fig->all_pegs_of($genome)
1802 :    
1803 :     Returns a list of all PEGs in the specified genome. Note that order is not
1804 :     specified.
1805 :    
1806 :     =cut
1807 :    
1808 :     sub pegs_of {
1809 :     my($self,$genome) = @_;
1810 :    
1811 :     return $self->all_features($genome,"peg");
1812 :     }
1813 :    
1814 :    
1815 :     =pod
1816 :    
1817 :     =head1 all_rnas_of
1818 :    
1819 :     usage: $fig->all_rnas($genome)
1820 :    
1821 :     Returns a list of all RNAs for the given genome.
1822 :    
1823 :     =cut
1824 :    
1825 :     sub rnas_of {
1826 :     my($self,$genome) = @_;
1827 :    
1828 :     return $self->all_features($genome,"rna");
1829 :     }
1830 :    
1831 :     =pod
1832 :    
1833 :     =head1 feature_aliases
1834 :    
1835 :     usage: @aliases = $fig->feature_aliases($fid) OR
1836 :     $aliases = $fig->feature_aliases($fid)
1837 :    
1838 :     Returns a list of aliases (gene IDs, arbitrary numbers assigned by authors, etc.) for the feature.
1839 :     These must come from the tbl files, so add them there if you want to see them here.
1840 :    
1841 :     In a scalar context, the aliases come back with commas separating them.
1842 :    
1843 :     =cut
1844 :    
1845 :     sub feature_aliases {
1846 :     my($self,$feature_id) = @_;
1847 : overbeek 1.87 my($rdbH,$relational_db_response,@aliases,$aliases,%aliases,$x);
1848 : efrank 1.1
1849 :     $rdbH = $self->db_handle;
1850 : overbeek 1.87 @aliases = ();
1851 : efrank 1.1 if (($relational_db_response = $rdbH->SQL("SELECT aliases FROM features WHERE ( id = \'$feature_id\' )")) &&
1852 :     (@$relational_db_response == 1))
1853 :     {
1854 :     $aliases = $relational_db_response->[0]->[0];
1855 : overbeek 1.87 %aliases = map { $_ => 1 } split(/,/,$aliases);
1856 :     if (($relational_db_response = $rdbH->SQL("SELECT alias FROM ext_alias WHERE ( id = \'$feature_id\' )")) &&
1857 :     (@$relational_db_response > 0))
1858 :     {
1859 :     foreach $x (@$relational_db_response)
1860 :     {
1861 :     $aliases{$x->[0]} = 1;
1862 :     }
1863 :     }
1864 :     @aliases = sort keys(%aliases);
1865 : efrank 1.1 }
1866 : overbeek 1.87
1867 :     return ((@aliases > 0) ? (wantarray() ? @aliases : join(",",@aliases)) : undef);
1868 : efrank 1.1 }
1869 :    
1870 :     =pod
1871 :    
1872 : overbeek 1.34 =head1 by_alias
1873 :    
1874 :     usage: $peg = $fig->by_alias($alias)
1875 :    
1876 :     Returns a FIG id if the alias can be converted. Right now we convert aliases
1877 :     of the form NP_* (RefSeq IDs) or gi|* (GenBank IDs)
1878 :    
1879 :     =cut
1880 :    
1881 :     sub by_alias {
1882 :     my($self,$alias) = @_;
1883 :     my($rdbH,$relational_db_response,$peg);
1884 :    
1885 : overbeek 1.86 if ($alias =~ /^fig\|\d+\.\d+\.peg\.\d+$/) { return $alias }
1886 :    
1887 : overbeek 1.34 $peg = "";
1888 :     $rdbH = $self->db_handle;
1889 :     if (($relational_db_response = $rdbH->SQL("SELECT id FROM ext_alias WHERE ( alias = \'$alias\' )")) &&
1890 :     (@$relational_db_response == 1))
1891 :     {
1892 :     $peg = $relational_db_response->[0]->[0];
1893 :     }
1894 :     return $peg;
1895 :     }
1896 :    
1897 :     =pod
1898 :    
1899 : efrank 1.1 =head1 possibly_truncated
1900 :    
1901 :     usage: $fig->possibly_truncated($fid)
1902 :    
1903 :     Returns true iff the feature occurs near the end of a contig.
1904 :    
1905 :     =cut
1906 :    
1907 :     sub possibly_truncated {
1908 :     my($self,$feature_id) = @_;
1909 :     my($loc);
1910 :    
1911 :     if ($loc = $self->feature_location($feature_id))
1912 :     {
1913 :     my $genome = &genome_of($feature_id);
1914 :     my ($contig,$beg,$end) = &boundaries_of($loc);
1915 :     if ((! $self->near_end($genome,$contig,$beg)) && (! $self->near_end($genome,$contig,$end)))
1916 :     {
1917 :     return 0;
1918 :     }
1919 :     }
1920 :     return 1;
1921 :     }
1922 :    
1923 :     sub near_end {
1924 :     my($self,$genome,$contig,$x) = @_;
1925 :    
1926 :     return (($x < 300) || ($x > ($self->contig_ln($genome,$contig) - 300)));
1927 :     }
1928 :    
1929 : overbeek 1.27 sub is_real_feature {
1930 :     my($self,$fid) = @_;
1931 :     my($relational_db_response);
1932 :    
1933 :     my $rdbH = $self->db_handle;
1934 :     return (($relational_db_response = $rdbH->SQL("SELECT id FROM features WHERE ( id = \'$fid\' )")) &&
1935 : mkubal 1.53 (@$relational_db_response == 1)) ? 1 : 0;
1936 : overbeek 1.27 }
1937 :    
1938 : efrank 1.1 ################ Routines to process functional coupling for PEGs ##########################
1939 :    
1940 :     =pod
1941 :    
1942 :     =head1 coupling_and_evidence
1943 :    
1944 :     usage: @coupling_data = $fig->coupling_and_evidence($fid,$bound,$sim_cutoff,$coupling_cutoff,$keep_record)
1945 :    
1946 :     A computation of couplings and evidence starts with a given peg and produces a list of
1947 :     3-tuples. Each 3-tuple is of the form
1948 :    
1949 :     [Score,CoupledToFID,Evidence]
1950 :    
1951 :     Evidence is a list of 2-tuples of FIDs that are close in other genomes (producing
1952 :     a "pair of close homologs" of [$peg,CoupledToFID]). The maximum score for a single
1953 :     PCH is 1, but "Score" is the sum of the scores for the entire set of PCHs.
1954 :    
1955 :     If $keep_record is true, the system records the information, asserting coupling for each
1956 :     of the pairs in the set of evidence, and asserting a pin from the given $fd through all
1957 :     of the PCH entries used in forming the score.
1958 :    
1959 :     =cut
1960 :    
1961 :     sub coupling_and_evidence {
1962 :     my($self,$feature_id,$bound,$sim_cutoff,$coupling_cutoff,$keep_record) = @_;
1963 :     my($neighbors,$neigh,$similar1,$similar2,@hits,$sc,$ev,$genome1);
1964 :    
1965 :     if ($feature_id =~ /^fig\|(\d+\.\d+)/)
1966 :     {
1967 :     $genome1 = $1;
1968 :     }
1969 :    
1970 :     my($contig,$beg,$end) = &FIG::boundaries_of($self->feature_location($feature_id));
1971 :     if (! $contig) { return () }
1972 :    
1973 :     ($neighbors,undef,undef) = $self->genes_in_region(&genome_of($feature_id),
1974 :     $contig,
1975 :     &min($beg,$end) - $bound,
1976 :     &max($beg,$end) + $bound);
1977 :     if (@$neighbors == 0) { return () }
1978 :     $similar1 = $self->acceptably_close($feature_id,$sim_cutoff);
1979 :     @hits = ();
1980 :    
1981 :     foreach $neigh (grep { $_ =~ /peg/ } @$neighbors)
1982 :     {
1983 :     next if ($neigh eq $feature_id);
1984 :     $similar2 = $self->acceptably_close($neigh,$sim_cutoff);
1985 :     ($sc,$ev) = $self->coupling_ev($genome1,$similar1,$similar2,$bound);
1986 :     if ($sc >= $coupling_cutoff)
1987 :     {
1988 :     push(@hits,[$sc,$neigh,$ev]);
1989 :     }
1990 :     }
1991 :     if ($keep_record)
1992 :     {
1993 :     $self->add_chr_clusters_and_pins($feature_id,\@hits);
1994 :     }
1995 :     return sort { $b->[0] <=> $a->[0] } @hits;
1996 :     }
1997 :    
1998 : overbeek 1.35 sub fast_coupling {
1999 :     my($self,$peg,$bound,$coupling_cutoff) = @_;
2000 :     my($genome,$genome1,$genome2,$peg1,$peg2,$peg3,%maps,$loc,$loc1,$loc2,$loc3);
2001 :     my($pairs,$sc,%ev);
2002 :    
2003 :     my @ans = ();
2004 :    
2005 :     $genome = &genome_of($peg);
2006 :     foreach $peg1 ($self->in_pch_pin_with($peg))
2007 :     {
2008 :     $peg1 =~ s/,.*$//;
2009 :     if ($peg ne $peg1)
2010 :     {
2011 :     $genome1 = &genome_of($peg1);
2012 :     $maps{$peg}->{$genome1} = $peg1;
2013 :     }
2014 :     }
2015 :    
2016 :     $loc = [&boundaries_of(scalar $self->feature_location($peg))];
2017 :     foreach $peg1 ($self->in_cluster_with($peg))
2018 :     {
2019 :     if ($peg ne $peg1)
2020 :     {
2021 :     # print STDERR "peg1=$peg1\n";
2022 :     $loc1 = [&boundaries_of(scalar $self->feature_location($peg1))];
2023 :     if (&close_enough($loc,$loc1,$bound))
2024 :     {
2025 :     foreach $peg2 ($self->in_pch_pin_with($peg1))
2026 :     {
2027 :     $genome2 = &genome_of($peg2);
2028 :     if (($peg3 = $maps{$peg}->{$genome2}) && ($peg2 ne $peg3))
2029 :     {
2030 :     $loc2 = [&boundaries_of(scalar $self->feature_location($peg2))];
2031 :     $loc3 = [&boundaries_of(scalar $self->feature_location($peg3))];
2032 :     if (&close_enough($loc2,$loc3,$bound))
2033 :     {
2034 :     push(@{$ev{$peg1}},[$peg3,$peg2]);
2035 :     }
2036 :     }
2037 :     }
2038 :     }
2039 :     }
2040 :     }
2041 :     foreach $peg1 (keys(%ev))
2042 :     {
2043 :     $pairs = $ev{$peg1};
2044 : overbeek 1.43 $sc = $self->score([$peg,map { $_->[0] } @$pairs]);
2045 : overbeek 1.35 if ($sc >= $coupling_cutoff)
2046 :     {
2047 :     push(@ans,[$sc,$peg1]);
2048 :     }
2049 :     }
2050 :     return sort { $b->[0] <=> $a->[0] } @ans;
2051 :     }
2052 :    
2053 :    
2054 :     sub score {
2055 : overbeek 1.43 my($self,$pegs) = @_;
2056 : overbeek 1.51 my(@ids);
2057 : overbeek 1.35
2058 : overbeek 1.51 if ($self->{_no9s_scoring})
2059 :     {
2060 :     @ids = map { $self->maps_to_id($_) } grep { $_ !~ /^fig\|999999/ } @$pegs;
2061 :     }
2062 :     else
2063 :     {
2064 :     @ids = map { $self->maps_to_id($_) } @$pegs;
2065 :     }
2066 : overbeek 1.43 return &score1($self,\@ids) - 1;
2067 :     }
2068 :    
2069 :     sub score1 {
2070 :     my($self,$pegs) = @_;
2071 :     my($sim);
2072 :     my($first,@rest) = @$pegs;
2073 :     my $count = 1;
2074 :     my %hits = map { $_ => 1 } @rest;
2075 :     my @ordered = sort { $b->[0] <=> $a->[0] }
2076 :     map { $sim = $_; [$sim->iden,$sim->id2] }
2077 :     grep { $hits{$_->id2} }
2078 :     $self->sims($first,1000,1,"raw");
2079 : overbeek 1.76 my %ordered = map { $_->[1] => 1 } @ordered;
2080 :     foreach $_ (@rest)
2081 :     {
2082 :     if (! $ordered{$_})
2083 :     {
2084 :     push(@ordered,[0,$_]);
2085 :     }
2086 :     }
2087 :    
2088 : overbeek 1.43 while ((@ordered > 0) && ($ordered[0]->[0] >= 97))
2089 : overbeek 1.35 {
2090 : overbeek 1.43 shift @ordered ;
2091 :     }
2092 :     while (@ordered > 0)
2093 :     {
2094 :     my $start = $ordered[0]->[0];
2095 :     $_ = shift @ordered;
2096 :     my @sub = ( $_->[1] );
2097 :     while ((@ordered > 0) && ($ordered[0]->[0] > ($start-3)))
2098 : overbeek 1.35 {
2099 : overbeek 1.43 $_ = shift @ordered;
2100 :     push(@sub, $_->[1]);
2101 : overbeek 1.35 }
2102 :    
2103 : overbeek 1.43 if (@sub == 1)
2104 :     {
2105 :     $count++;
2106 :     }
2107 :     else
2108 :     {
2109 :     $count += &score1($self,\@sub);
2110 :     }
2111 : overbeek 1.35 }
2112 : overbeek 1.43 return $count;
2113 : overbeek 1.35 }
2114 :    
2115 : efrank 1.1 =pod
2116 :    
2117 :     =head1 add_chr_clusters_and_pins
2118 :    
2119 :     usage: $fig->add_chr_clusters_and_pins($peg,$hits)
2120 :    
2121 :     The system supports retaining data relating to functional coupling. If a user
2122 :     computes evidence once and then saves it with this routine, data relating to
2123 :     both "the pin" and the "clusters" (in all of the organisms supporting the
2124 :     functional coupling) will be saved.
2125 :    
2126 :     $hits must be a pointer to a list of 3-tuples of the sort returned by
2127 :     $fig->coupling_and_evidence.
2128 :    
2129 :     =cut
2130 :    
2131 :     sub add_chr_clusters_and_pins {
2132 :     my($self,$peg,$hits) = @_;
2133 :     my(@clusters,@pins,$x,$sc,$neigh,$pairs,$y,@corr,@orgs,%projection);
2134 :     my($genome,$cluster,$pin,$peg2);
2135 :    
2136 :     if (@$hits > 0)
2137 :     {
2138 :     @clusters = ();
2139 :     @pins = ();
2140 :     push(@clusters,[$peg,map { $_->[1] } @$hits]);
2141 :     foreach $x (@$hits)
2142 :     {
2143 :     ($sc,$neigh,$pairs) = @$x;
2144 :     push(@pins,[$neigh,map { $_->[1] } @$pairs]);
2145 :     foreach $y (@$pairs)
2146 :     {
2147 :     $peg2 = $y->[0];
2148 :     if ($peg2 =~ /^fig\|(\d+\.\d+)/)
2149 :     {
2150 :     $projection{$1}->{$peg2} = 1;
2151 :     }
2152 :     }
2153 :     }
2154 :     @corr = ();
2155 :     @orgs = keys(%projection);
2156 :     if (@orgs > 0)
2157 :     {
2158 :     foreach $genome (sort { $a <=> $b } @orgs)
2159 :     {
2160 :     push(@corr,sort { &FIG::by_fig_id($a,$b) } keys(%{$projection{$genome}}));
2161 :     }
2162 :     push(@pins,[$peg,@corr]);
2163 :     }
2164 :    
2165 :     foreach $cluster (@clusters)
2166 :     {
2167 :     $self->add_chromosomal_cluster($cluster);
2168 :     }
2169 :    
2170 :     foreach $pin (@pins)
2171 :     {
2172 :     $self->add_pch_pin($pin);
2173 :     }
2174 :     }
2175 :     }
2176 :    
2177 :     sub coupling_ev {
2178 :     my($self,$genome1,$sim1,$sim2,$bound) = @_;
2179 :     my($ev,$sc,$i,$j);
2180 :    
2181 :     $ev = [];
2182 :     $sc = 0;
2183 :    
2184 :     $i = 0;
2185 :     $j = 0;
2186 :     while (($i < @$sim1) && ($j < @$sim2))
2187 :     {
2188 :     if ($sim1->[$i]->[0] < $sim2->[$j]->[0])
2189 :     {
2190 :     $i++;
2191 :     }
2192 :     elsif ($sim1->[$i]->[0] > $sim2->[$j]->[0])
2193 :     {
2194 :     $j++;
2195 :     }
2196 :     else
2197 :     {
2198 :     $sc += $self->accumulate_ev($genome1,$sim1->[$i]->[1],$sim2->[$j]->[1],$bound,$ev);
2199 :     $i++;
2200 :     $j++;
2201 :     }
2202 :     }
2203 : overbeek 1.43 return ($self->score([map { $_->[0] } @$ev]),$ev);
2204 : efrank 1.1 }
2205 :    
2206 :     sub accumulate_ev {
2207 :     my($self,$genome1,$feature_ids1,$feature_ids2,$bound,$ev) = @_;
2208 : overbeek 1.43 my($genome2,@locs1,@locs2,$i,$j,$x);
2209 : efrank 1.1
2210 :     if ((@$feature_ids1 == 0) || (@$feature_ids2 == 0)) { return 0 }
2211 :    
2212 :     $feature_ids1->[0] =~ /^fig\|(\d+\.\d+)/;
2213 :     $genome2 = $1;
2214 :     @locs1 = map { $x = $self->feature_location($_); $x ? [&boundaries_of($x)] : () } @$feature_ids1;
2215 :     @locs2 = map { $x = $self->feature_location($_); $x ? [&boundaries_of($x)] : () } @$feature_ids2;
2216 :    
2217 :     for ($i=0; ($i < @$feature_ids1); $i++)
2218 :     {
2219 :     for ($j=0; ($j < @$feature_ids2); $j++)
2220 :     {
2221 :     if (($feature_ids1->[$i] ne $feature_ids2->[$j]) &&
2222 :     &close_enough($locs1[$i],$locs2[$j],$bound))
2223 :     {
2224 :     push(@$ev,[$feature_ids1->[$i],$feature_ids2->[$j]]);
2225 :     }
2226 :     }
2227 :     }
2228 :     }
2229 :    
2230 :     sub close_enough {
2231 :     my($locs1,$locs2,$bound) = @_;
2232 :    
2233 :     # print STDERR &Dumper(["close enough",$locs1,$locs2]);
2234 :     return (($locs1->[0] eq $locs2->[0]) && (abs((($locs1->[1]+$locs1->[2])/2) - (($locs2->[1]+$locs2->[2])/2)) <= $bound));
2235 :     }
2236 :    
2237 :     sub acceptably_close {
2238 :     my($self,$feature_id,$sim_cutoff) = @_;
2239 :     my(%by_org,$id2,$genome,$sim);
2240 :    
2241 :     my($ans) = [];
2242 :    
2243 : overbeek 1.31 foreach $sim ($self->sims($feature_id,1000,$sim_cutoff,"fig"))
2244 : efrank 1.1 {
2245 :     $id2 = $sim->id2;
2246 :     if ($id2 =~ /^fig\|(\d+\.\d+)/)
2247 :     {
2248 :     my $genome = $1;
2249 : overbeek 1.51 if (! $self->is_eukaryotic($genome))
2250 : efrank 1.1 {
2251 :     push(@{$by_org{$genome}},$id2);
2252 :     }
2253 :     }
2254 :     }
2255 :     foreach $genome (sort { $a <=> $b } keys(%by_org))
2256 :     {
2257 :     push(@$ans,[$genome,$by_org{$genome}]);
2258 :     }
2259 :     return $ans;
2260 :     }
2261 :    
2262 :     ################ Translations of PEGsand External Protein Sequences ##########################
2263 :    
2264 :    
2265 :     =pod
2266 :    
2267 :     =head1 translatable
2268 :    
2269 :     usage: $fig->translatable($prot_id)
2270 :    
2271 :     The system takes any number of sources of protein sequences as input (and builds an nr
2272 :     for the purpose of computing similarities). For each of these input fasta files, it saves
2273 :     (in the DB) a filename, seek address and length so that it can go get the translation if
2274 :     needed. This routine simply returns true iff info on the translation exists.
2275 :    
2276 :     =cut
2277 :    
2278 :     sub translatable {
2279 :     my($self,$prot) = @_;
2280 :    
2281 :     return &translation_length($self,$prot) ? 1 : 0;
2282 :     }
2283 :    
2284 :    
2285 :     =pod
2286 :    
2287 :     =head1 translation_length
2288 :    
2289 :     usage: $len = $fig->translation_length($prot_id)
2290 :    
2291 :     The system takes any number of sources of protein sequences as input (and builds an nr
2292 :     for the purpose of computing similarities). For each of these input fasta files, it saves
2293 :     (in the DB) a filename, seek address and length so that it can go get the translation if
2294 :     needed. This routine returns the length of a translation. This does not require actually
2295 :     retrieving the translation.
2296 :    
2297 :     =cut
2298 :    
2299 :     sub translation_length {
2300 :     my($self,$prot) = @_;
2301 :    
2302 :     $prot =~ s/^([^\|]+\|[^\|]+)\|.*$/$1/;
2303 :     my $rdbH = $self->db_handle;
2304 :     my $relational_db_response = $rdbH->SQL("SELECT slen FROM protein_sequence_seeks
2305 :     WHERE id = \'$prot\' ");
2306 :    
2307 :     return (@$relational_db_response == 1) ? $relational_db_response->[0]->[0] : undef;
2308 :     }
2309 :    
2310 :    
2311 :     =pod
2312 :    
2313 :     =head1 get_translation
2314 :    
2315 :     usage: $translation = $fig->get_translation($prot_id)
2316 :    
2317 :     The system takes any number of sources of protein sequences as input (and builds an nr
2318 :     for the purpose of computing similarities). For each of these input fasta files, it saves
2319 :     (in the DB) a filename, seek address and length so that it can go get the translation if
2320 :     needed. This routine returns a protein sequence.
2321 :    
2322 :     =cut
2323 :    
2324 :     sub get_translation {
2325 :     my($self,$id) = @_;
2326 :     my($rdbH,$relational_db_response,$fileN,$file,$fh,$seek,$ln,$tran);
2327 :    
2328 :     $rdbH = $self->db_handle;
2329 :     $id =~ s/^([^\|]+\|[^\|]+)\|.*$/$1/;
2330 :    
2331 :     $relational_db_response = $rdbH->SQL("SELECT fileno, seek, len FROM protein_sequence_seeks WHERE id = \'$id\' ");
2332 :    
2333 :     if ($relational_db_response && @$relational_db_response == 1)
2334 :     {
2335 :     ($fileN,$seek,$ln) = @{$relational_db_response->[0]};
2336 :     if (($fh = $self->openF($self->N2file($fileN))) &&
2337 :     ($ln > 10))
2338 :     {
2339 :     seek($fh,$seek,0);
2340 :     read($fh,$tran,$ln-1);
2341 :     $tran =~ s/\s//g;
2342 :     return $tran;
2343 :     }
2344 :     }
2345 :     return '';
2346 :     }
2347 :    
2348 :     =pod
2349 :    
2350 :     =head1 mapped_prot_ids
2351 :    
2352 :     usage: @mapped = $fig->mapped_prot_ids($prot)
2353 :    
2354 :     This routine is at the heart of maintaining synonyms for protein sequences. The system
2355 :     determines which protein sequences are "essentially the same". These may differ in length
2356 :     (presumably due to miscalled starts), but the tails are identical (and the heads are not "too" extended).
2357 :     Anyway, the set of synonyms is returned as a list of 2-tuples [Id,length] sorted
2358 :     by length.
2359 :    
2360 :     =cut
2361 :    
2362 :     sub mapped_prot_ids {
2363 :     my($self,$id) = @_;
2364 :    
2365 :     my $rdbH = $self->db_handle;
2366 :     my $relational_db_response = $rdbH->SQL("SELECT maps_to FROM peg_synonyms WHERE syn_id = \'$id\' ");
2367 :     if ($relational_db_response && (@$relational_db_response == 1))
2368 :     {
2369 :     $id = $relational_db_response->[0]->[0];
2370 :     }
2371 :    
2372 :     $relational_db_response = $rdbH->SQL("SELECT syn_id,syn_ln,maps_to_ln FROM peg_synonyms WHERE maps_to = \'$id\' ");
2373 :     if ($relational_db_response && (@$relational_db_response > 0))
2374 :     {
2375 :     return ([$id,$relational_db_response->[0]->[2]],map { [$_->[0],$_->[1]] } @$relational_db_response);
2376 :     }
2377 :     else
2378 :     {
2379 :     return ([$id,$self->translation_length($id)]);
2380 :     }
2381 : overbeek 1.14 }
2382 :    
2383 :     sub maps_to_id {
2384 :     my($self,$id) = @_;
2385 :    
2386 :     my $rdbH = $self->db_handle;
2387 :     my $relational_db_response = $rdbH->SQL("SELECT maps_to FROM peg_synonyms WHERE syn_id = \'$id\' ");
2388 :     return ($relational_db_response && (@$relational_db_response == 1)) ? $relational_db_response->[0]->[0] : $id;
2389 : efrank 1.1 }
2390 :    
2391 :     ################ Assignments of Function to PEGs ##########################
2392 :    
2393 :     =pod
2394 :    
2395 :     =head1 function_of
2396 :    
2397 :     usage: @functions = $fig->function_of($peg) OR
2398 :     $function = $fig->function_of($peg,$user)
2399 :    
2400 :     In a list context, you get back a list of 2-tuples. Each 2-tuple is of the
2401 :     form [MadeBy,Function].
2402 :    
2403 :     In a scalar context,
2404 :    
2405 :     1. user is "master" if not specified
2406 :     2. function returned is the user's, if one exists; otherwise, master's, if one exists
2407 :    
2408 :     In a scalar context, you get just the function.
2409 :    
2410 :     =cut
2411 :    
2412 :     # Note that we do not return confidence. I propose a separate function to get both
2413 :     # function and confidence
2414 :     #
2415 :     sub function_of {
2416 :     my($self,$id,$user) = @_;
2417 :     my($relational_db_response,@tmp,$entry,$i);
2418 :     my $wantarray = wantarray();
2419 :     my $rdbH = $self->db_handle;
2420 :    
2421 :     if (($id =~ /^fig\|(\d+\.\d+\.peg\.\d+)/) && ($wantarray || $user))
2422 :     {
2423 :     if (($relational_db_response = $rdbH->SQL("SELECT made_by,assigned_function FROM assigned_functions WHERE ( prot = \'$id\' )")) &&
2424 :     (@$relational_db_response >= 1))
2425 :     {
2426 :     @tmp = sort { $a->[0] cmp $b->[0] } map { [$_->[0],$_->[1]] } @$relational_db_response;
2427 :     for ($i=0; ($i < @tmp) && ($tmp[$i]->[0] ne "master"); $i++) {}
2428 :     if ($i < @tmp)
2429 :     {
2430 :     $entry = splice(@tmp,$i,1);
2431 :     unshift @tmp, ($entry);
2432 :     }
2433 :    
2434 :     my $val;
2435 :     if ($wantarray) { return @tmp }
2436 :     elsif ($user && ($val = &extract_by_who(\@tmp,$user))) { return $val }
2437 :     elsif ($user && ($val = &extract_by_who(\@tmp,"master"))) { return $val }
2438 :     else { return "" }
2439 :     }
2440 :     }
2441 :     else
2442 :     {
2443 :     if (($relational_db_response = $rdbH->SQL("SELECT assigned_function FROM assigned_functions WHERE ( prot = \'$id\' AND made_by = \'master\' )")) &&
2444 :     (@$relational_db_response >= 1))
2445 :     {
2446 :     return $wantarray ? (["master",$relational_db_response->[0]->[0]]) : $relational_db_response->[0]->[0];
2447 :     }
2448 :     }
2449 :    
2450 :     return $wantarray ? () : "";
2451 :     }
2452 :    
2453 :     =pod
2454 :    
2455 :     =head1 translated_function_of
2456 :    
2457 :     usage: $function = $fig->translated_function_of($peg,$user)
2458 :    
2459 :     You get just the translated function.
2460 :    
2461 :     =cut
2462 :    
2463 :     sub translated_function_of {
2464 :     my($self,$id,$user) = @_;
2465 :    
2466 :     my $func = $self->function_of($id,$user);
2467 :     if ($func)
2468 :     {
2469 :     $func = $self->translate_function($func);
2470 :     }
2471 :     return $func;
2472 :     }
2473 :    
2474 :    
2475 :     sub extract_by_who {
2476 :     my($xL,$who) = @_;
2477 :     my($i);
2478 :    
2479 :     for ($i=0; ($i < @$xL) && ($xL->[$i]->[0] ne $who); $i++) {}
2480 :     return ($i < @$xL) ? $xL->[$i]->[1] : "";
2481 :     }
2482 :    
2483 :    
2484 :     =pod
2485 :    
2486 :     =head1 translate_function
2487 :    
2488 :     usage: $translated_func = $fig->translate_function($func)
2489 :    
2490 :     Translates a function based on the function.synonyms table.
2491 :    
2492 :     =cut
2493 :    
2494 :     sub translate_function {
2495 :     my($self,$function) = @_;
2496 :    
2497 :     my ($tran,$from,$to,$line);
2498 :     if (! ($tran = $self->{_function_translation}))
2499 :     {
2500 :     $tran = {};
2501 :     if (open(TMP,"<$FIG_Config::global/function.synonyms"))
2502 :     {
2503 :     while (defined($line = <TMP>))
2504 :     {
2505 : golsen 1.44 chomp $line;
2506 : efrank 1.1 ($from,$to) = split(/\t/,$line);
2507 :     $tran->{$from} = $to;
2508 :     }
2509 :     close(TMP);
2510 :     }
2511 : overbeek 1.22 foreach $from (keys(%$tran))
2512 :     {
2513 :     $to = $tran->{$from};
2514 :     if ($tran->{$to})
2515 :     {
2516 :     delete $tran->{$from};
2517 :     }
2518 :     }
2519 : efrank 1.1 $self->{_function_translation} = $tran;
2520 :     }
2521 : overbeek 1.4
2522 :     while ($to = $tran->{$function})
2523 :     {
2524 :     $function = $to;
2525 :     }
2526 :     return $function;
2527 : efrank 1.1 }
2528 :    
2529 :     =pod
2530 :    
2531 :     =head1 assign_function
2532 :    
2533 :     usage: $fig->assign_function($peg,$user,$function,$confidence)
2534 :    
2535 :     Assigns a function. Note that confidence can (and should be if unusual) included.
2536 :     Note that no annotation is written. This should normally be done in a separate
2537 :     call of the form
2538 :    
2539 :    
2540 :    
2541 :     =cut
2542 :    
2543 :     sub assign_function {
2544 :     my($self,$peg,$user,$function,$confidence) = @_;
2545 :     my($role,$roleQ);
2546 :    
2547 :     my $rdbH = $self->db_handle;
2548 :     $confidence = $confidence ? $confidence : "";
2549 :     my $genome = $self->genome_of($peg);
2550 :    
2551 :     $rdbH->SQL("DELETE FROM assigned_functions WHERE ( prot = \'$peg\' AND made_by = \'$user\' )");
2552 :    
2553 :     my $funcQ = quotemeta $function;
2554 :     $rdbH->SQL("INSERT INTO assigned_functions ( prot, made_by, assigned_function, quality, org ) VALUES ( \'$peg\', \'$user\', \'$funcQ\', \'$confidence\', \'$genome\' )");
2555 :     $rdbH->SQL("DELETE FROM roles WHERE ( prot = \'$peg\' AND made_by = \'$user\' )");
2556 :    
2557 :     foreach $role (&roles_of_function($function))
2558 :     {
2559 :     $roleQ = quotemeta $role;
2560 :     $rdbH->SQL("INSERT INTO roles ( prot, role, made_by, org ) VALUES ( \'$peg\', '$roleQ\', \'$user\', \'$genome\' )");
2561 :     }
2562 :    
2563 :     &verify_dir("$FIG_Config::organisms/$genome/UserModels");
2564 :     if ($user ne "master")
2565 :     {
2566 :     &verify_dir("$FIG_Config::organisms/$genome/UserModels/$user");
2567 :     }
2568 :    
2569 : overbeek 1.66 my $file;
2570 :     if ((($user eq "master") && ($file = "$FIG_Config::organisms/$genome/assigned_functions") && open(TMP,">>$file")) ||
2571 :     (($user ne "master") && ($file = "$FIG_Config::organisms/$genome/UserModels/$user/assigned_functions") && open(TMP,">>$file")))
2572 : efrank 1.1 {
2573 :     flock(TMP,LOCK_EX) || confess "cannot lock assigned_functions";
2574 :     seek(TMP,0,2) || confess "failed to seek to the end of the file";
2575 :     print TMP "$peg\t$function\t$confidence\n";
2576 :     close(TMP);
2577 : overbeek 1.66 chmod(0777,$file);
2578 : efrank 1.1 return 1;
2579 :     }
2580 :     return 0;
2581 :     }
2582 :    
2583 :     sub hypo {
2584 :     my $x = (@_ == 1) ? $_[0] : $_[1];
2585 :    
2586 : overbeek 1.23 if (! $x) { return 1 }
2587 :     if ($x =~ /hypoth/i) { return 1 }
2588 :     if ($x =~ /conserved protein/i) { return 1 }
2589 : overbeek 1.63 if ($x =~ /gene product/i) { return 1 }
2590 :     if ($x =~ /interpro/i) { return 1 }
2591 :     if ($x =~ /B[sl][lr]\d/i) { return 1 }
2592 :     if ($x =~ /^U\d/) { return 1 }
2593 :     if ($x =~ /^orf/i) { return 1 }
2594 :     if ($x =~ /uncharacterized/i) { return 1 }
2595 :     if ($x =~ /psedogene/i) { return 1 }
2596 :     if ($x =~ /^predicted/i) { return 1 }
2597 :     if ($x =~ /AGR_/) { return 1 }
2598 : overbeek 1.51 if ($x =~ /similar to/i) { return 1 }
2599 : overbeek 1.63 if ($x =~ /similarity/i) { return 1 }
2600 :     if ($x =~ /glimmer/i) { return 1 }
2601 : overbeek 1.23 if ($x =~ /unknown/i) { return 1 }
2602 :     return 0;
2603 : efrank 1.1 }
2604 :    
2605 :     ############################ Similarities ###############################
2606 :    
2607 :     =pod
2608 :    
2609 :     =head1 sims
2610 :    
2611 :     usage: @sims = $fig->sims($peg,$maxN,$maxP,$select)
2612 :    
2613 :     Returns a list of similarities for $peg such that
2614 :    
2615 :     there will be at most $maxN similarities,
2616 :    
2617 :     each similarity will have a P-score <= $maxP, and
2618 :    
2619 :     $select gives processing instructions:
2620 :    
2621 :     "raw" means that the similarities will not be expanded (by far fastest option)
2622 :     "fig" means return only similarities to fig genes
2623 :     "all" means that you want all the expanded similarities.
2624 :    
2625 :     By "expanded", we refer to taking a "raw similarity" against an entry in the non-redundant
2626 :     protein collection, and converting it to a set of similarities (one for each of the
2627 :     proteins that are essentially identical to the representative in the nr).
2628 :    
2629 :     =cut
2630 :    
2631 :     sub sims {
2632 : overbeek 1.29 my ($self,$id,$maxN,$maxP,$select,$max_expand) = @_;
2633 : efrank 1.1 my($sim);
2634 : overbeek 1.29 $max_expand = defined($max_expand) ? $max_expand : $maxN;
2635 : efrank 1.1
2636 :     my @sims = ();
2637 :     my @maps_to = $self->mapped_prot_ids($id);
2638 :     if (@maps_to > 0)
2639 :     {
2640 :     my $rep_id = $maps_to[0]->[0];
2641 :     my @entry = grep { $_->[0] eq $id } @maps_to;
2642 :     if ((@entry == 1) && defined($entry[0]->[1]))
2643 :     {
2644 :     if ((! defined($maps_to[0]->[1])) ||
2645 :     (! defined($entry[0]->[1])))
2646 :     {
2647 :     print STDERR &Dumper(\@maps_to,\@entry);
2648 :     confess "bad";
2649 :     }
2650 :     my $delta = $maps_to[0]->[1] - $entry[0]->[1];
2651 :     my @raw_sims = &get_raw_sims($self,$rep_id,$maxN,$maxP);
2652 : efrank 1.2 if ($id ne $rep_id)
2653 : efrank 1.1 {
2654 : efrank 1.2 foreach $sim (@raw_sims)
2655 :     {
2656 : efrank 1.1
2657 :     $sim->[0] = $id;
2658 :     $sim->[6] -= $delta;
2659 :     $sim->[7] -= $delta;
2660 :     }
2661 :     }
2662 : overbeek 1.88 if (($max_expand > 0) && ($select ne "raw"))
2663 :     {
2664 :     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'));
2665 :     $max_expand++;
2666 :     }
2667 :     @sims = grep { $_->id1 ne $_->id2 } &expand_raw_sims($self,\@raw_sims,$maxP,$select,0,$max_expand);
2668 : efrank 1.1 }
2669 :     }
2670 :     return @sims;
2671 :     }
2672 :    
2673 :     sub expand_raw_sims {
2674 : overbeek 1.29 my($self,$raw_sims,$maxP,$select,$dups,$max_expand) = @_;
2675 : efrank 1.1 my($sim,$id2,%others,$x);
2676 :    
2677 :     my @sims = ();
2678 :     foreach $sim (@$raw_sims)
2679 :     {
2680 :     next if ($sim->psc > $maxP);
2681 :     $id2 = $sim->id2;
2682 :     next if ($others{$id2} && (! $dups));
2683 :     $others{$id2} = 1;
2684 : overbeek 1.37 if (($select && ($select eq "raw")) || ($max_expand <= 0))
2685 : efrank 1.1 {
2686 :     push(@sims,$sim);
2687 :     }
2688 :     else
2689 :     {
2690 :     my @relevant;
2691 : overbeek 1.29 $max_expand--;
2692 :    
2693 : efrank 1.1 my @maps_to = $self->mapped_prot_ids($id2);
2694 :     if ((! $select) || ($select eq "fig"))
2695 :     {
2696 :     @relevant = grep { $_->[0] =~ /^fig/ } @maps_to;
2697 :     }
2698 :     elsif ($select && ($select =~ /^ext/i))
2699 :     {
2700 :     @relevant = grep { $_->[0] !~ /^fig/ } @maps_to;
2701 :     }
2702 :     else
2703 :     {
2704 :     @relevant = @maps_to;
2705 :     }
2706 :    
2707 :     foreach $x (@relevant)
2708 :     {
2709 :     my $sim1 = [@$sim];
2710 :     my($x_id,$x_ln) = @$x;
2711 :     defined($x_ln) || confess "x_ln id2=$id2 x_id=$x_id";
2712 :     defined($maps_to[0]->[1]) || confess "maps_to";
2713 :     my $delta2 = $maps_to[0]->[1] - $x_ln;
2714 :     $sim1->[1] = $x_id;
2715 :     $sim1->[8] -= $delta2;
2716 :     $sim1->[9] -= $delta2;
2717 :     bless($sim1,"Sim");
2718 :     push(@sims,$sim1);
2719 :     }
2720 :     }
2721 :     }
2722 :     return @sims;
2723 :     }
2724 :    
2725 :     sub get_raw_sims {
2726 :     my($self,$rep_id,$maxN,$maxP) = @_;
2727 : overbeek 1.84 my(@sims,$seek,$fileN,$ln,$fh,$file,$readC,@lines,$i,$sim);
2728 : efrank 1.1 my($sim_chunk,$psc,$id2);
2729 :    
2730 :     $maxN = $maxN ? $maxN : 500;
2731 :    
2732 :     @sims = ();
2733 :     my $rdbH = $self->db_handle;
2734 :     my $relational_db_response = $rdbH->SQL("SELECT seek, fileN, len FROM sim_seeks WHERE id = \'$rep_id\' ");
2735 :     foreach $sim_chunk (@$relational_db_response)
2736 :     {
2737 :     ($seek,$fileN,$ln) = @$sim_chunk;
2738 :     $file = $self->N2file($fileN);
2739 :     $fh = $self->openF($file);
2740 :     if (! $fh)
2741 :     {
2742 :     confess "could not open sims for $file";
2743 :     }
2744 : overbeek 1.84 $readC = &read_block($fh,$seek,$ln-1);
2745 : efrank 1.1 @lines = grep {
2746 :     (@$_ == 15) &&
2747 :     ($_->[12] =~ /^\d+$/) &&
2748 :     ($_->[13] =~ /^\d+$/) &&
2749 :     ($_->[6] =~ /^\d+$/) &&
2750 :     ($_->[7] =~ /^\d+$/) &&
2751 :     ($_->[8] =~ /^\d+$/) &&
2752 :     ($_->[9] =~ /^\d+$/) &&
2753 :     ($_->[2] =~ /^[0-9.]+$/) &&
2754 :     ($_->[10] =~ /^[0-9.e-]+$/)
2755 :     }
2756 :     map { [split(/\t/,$_),"blastp"] }
2757 : overbeek 1.98 @$readC;
2758 : efrank 1.1
2759 :     @lines = sort { $a->[10] <=> $b->[10] } @lines;
2760 :    
2761 :     for ($i=0; ($i < @lines); $i++)
2762 :     {
2763 :     $psc = $lines[$i]->[10];
2764 :     $id2 = $lines[$i]->[1];
2765 :     if ($maxP >= $psc)
2766 :     {
2767 :     $sim = $lines[$i];
2768 :     bless($sim,"Sim");
2769 :     push(@sims,$sim);
2770 :     if (@sims == $maxN) { return @sims }
2771 :     }
2772 :     }
2773 :     }
2774 :     return @sims;
2775 :     }
2776 :    
2777 : overbeek 1.84 sub read_block {
2778 :     my($fh,$seek,$ln) = @_;
2779 :     my($piece,$readN);
2780 :    
2781 :     seek($fh,$seek,0);
2782 : overbeek 1.98 my @lines = ();
2783 :     my $leftover = "";
2784 : overbeek 1.84 while ($ln > 0)
2785 :     {
2786 :     my $ln1 = ($ln <= 10000) ? $ln : 10000;
2787 :     $readN = read($fh,$piece,$ln1);
2788 :     ($readN == $ln1)
2789 :     || confess "could not read the block of sims at $seek for $ln1 characters; $readN actually read";
2790 : overbeek 1.98 my @tmp = split(/\n/,$piece);
2791 :     if ($leftover)
2792 :     {
2793 :     $tmp[0] = $leftover . $tmp[0];
2794 :     }
2795 :    
2796 :     if (substr($piece,-1) eq "\n")
2797 :     {
2798 :     $leftover = "";
2799 :     }
2800 :     else
2801 :     {
2802 :     $leftover = pop @tmp;
2803 :     }
2804 :     push(@lines,@tmp);
2805 : overbeek 1.84 $ln -= 10000;
2806 :     }
2807 : overbeek 1.98 if ($leftover) { push(@lines,$leftover) }
2808 :     return \@lines;
2809 : overbeek 1.84 }
2810 :    
2811 :    
2812 : overbeek 1.73 sub bbhs {
2813 :     my($self,$peg,$cutoff) = @_;
2814 : overbeek 1.74 my($sim,$peg2,$genome2,$i,@sims2,%seen);
2815 : overbeek 1.73
2816 :     $cutoff = defined($cutoff) ? $cutoff : 1.0e-10;
2817 :     my @bbhs = ();
2818 : overbeek 1.100 my @precomputed = ();
2819 :     my $rdbH = $self->db_handle;
2820 :     my $relational_db_response = $rdbH->SQL("SELECT seek, others FROM bbhs WHERE peg = \'$peg\' ");
2821 :     if (@$relational_db_response == 1)
2822 :     {
2823 :     my($seek,$others) = @{$relational_db_response->[0]};
2824 :     if (open(CORES,"<$FIG_Config::global/bbh.cores"))
2825 :     {
2826 :     seek(CORES,$seek,0);
2827 :     $_ = <CORES>;
2828 :     close(CORES);
2829 :     chop;
2830 :     push(@precomputed,split(/,/,$_));
2831 :     }
2832 :     push(@precomputed,split(/,/,$others));
2833 :     }
2834 :     my %bbhs = map { $_ => 1 } @precomputed;
2835 : overbeek 1.73
2836 :     foreach $sim ($self->sims($peg,10000,$cutoff,"fig"))
2837 :     {
2838 :     $peg2 = $sim->id2;
2839 : overbeek 1.100 if ($bbhs{$peg2})
2840 : overbeek 1.73 {
2841 :     push(@bbhs,[$peg2,$sim->psc]);
2842 :     }
2843 :     }
2844 :     return @bbhs;
2845 :     }
2846 :    
2847 : efrank 1.1 =pod
2848 :    
2849 :     =head1 dsims
2850 :    
2851 :     usage: @sims = $fig->dsims($peg,$maxN,$maxP,$select)
2852 :    
2853 :     Returns a list of similarities for $peg such that
2854 :    
2855 :     there will be at most $maxN similarities,
2856 :    
2857 :     each similarity will have a P-score <= $maxP, and
2858 :    
2859 :     $select gives processing instructions:
2860 :    
2861 :     "raw" means that the similarities will not be expanded (by far fastest option)
2862 :     "fig" means return only similarities to fig genes
2863 :     "all" means that you want all the expanded similarities.
2864 :    
2865 :     By "expanded", we refer to taking a "raw similarity" against an entry in the non-redundant
2866 :     protein collection, and converting it to a set of similarities (one for each of the
2867 :     proteins that are essentially identical to the representative in the nr).
2868 :    
2869 :     The "dsims" or "dynamic sims" are not precomputed. They are computed using a heuristic which
2870 :     is much faster than blast, but misses some similarities. Essentially, you have an "index" or
2871 :     representative sequences, a quick blast is done against it, and if there are any hits these are
2872 :     used to indicate which sub-databases to blast against.
2873 :    
2874 :     =cut
2875 :    
2876 :     sub dsims {
2877 :     my($self,$id,$seq,$maxN,$maxP,$select) = @_;
2878 :     my($sim,$sub_dir,$db,$hit,@hits,%in);
2879 :    
2880 :     my @index = &blastit($id,$seq,"$FIG_Config::global/SimGen/exemplar.fasta",1.0e-3);
2881 :     foreach $sim (@index)
2882 :     {
2883 :     if ($sim->id2 =~ /_(\d+)$/)
2884 :     {
2885 :     $in{$1}++;
2886 :     }
2887 :     }
2888 :    
2889 :     @hits = ();
2890 :     foreach $db (keys(%in))
2891 :     {
2892 :     $sub_dir = $db % 1000;
2893 :     push(@hits,&blastit($id,$seq,"$FIG_Config::global/SimGen/AccessSets/$sub_dir/$db",$maxP));
2894 :    
2895 :     }
2896 :    
2897 :     if (@hits == 0)
2898 :     {
2899 :     push(@hits,&blastit($id,$seq,"$FIG_Config::global/SimGen/nohit.fasta",$maxP));
2900 :     }
2901 :    
2902 :     @hits = sort { ($a->psc <=> $b->psc) or ($a->iden cmp $b->iden) } grep { $_->id2 ne $id } @hits;
2903 :     if ($maxN && ($maxN < @hits)) { $#hits = $maxN - 1 }
2904 : overbeek 1.69 return &expand_raw_sims($self,\@hits,$maxP,$select);
2905 : efrank 1.1 }
2906 :    
2907 :     sub blastit {
2908 :     my($id,$seq,$db,$maxP) = @_;
2909 :    
2910 :     if (! $maxP) { $maxP = 1.0e-5 }
2911 :     my $tmp = &Blast::blastp([[$id,$seq]],$db,"-e $maxP");
2912 :     my $tmp1 = $tmp->{$id};
2913 :     if ($tmp1)
2914 :     {
2915 :     return @$tmp1;
2916 :     }
2917 :     return ();
2918 :     }
2919 :    
2920 : overbeek 1.33 sub related_by_func_sim {
2921 :     my($self,$peg,$user) = @_;
2922 :     my($func,$sim,$id2,%related);
2923 :    
2924 :     if (($func = $self->function_of($peg,$user)) && (! &FIG::hypo($func)))
2925 :     {
2926 :     foreach $sim ($self->sims($peg,500,1,"fig",500))
2927 :     {
2928 :     $id2 = $sim->id2;
2929 :     if ($func eq $self->function_of($id2,$user))
2930 :     {
2931 :     $related{$id2} = 1;
2932 :     }
2933 :     }
2934 :     }
2935 :     return keys(%related);
2936 :     }
2937 :    
2938 : efrank 1.1 ################################# chromosomal clusters ####################################
2939 :    
2940 :     =pod
2941 :    
2942 :     =head1 in_cluster_with
2943 :    
2944 :     usage: @pegs = $fig->in_cluster_with($peg)
2945 :    
2946 :     Returns the set of pegs that are thought to be clustered with $peg (on the
2947 :     chromosome).
2948 :    
2949 :     =cut
2950 :    
2951 :     sub in_cluster_with {
2952 :     my($self,$peg) = @_;
2953 :     my($set,$id,%in);
2954 :    
2955 :     return $self->in_set_with($peg,"chromosomal_clusters","cluster_id");
2956 :     }
2957 :    
2958 :     =pod
2959 :    
2960 :     =head1 add_chromosomal_clusters
2961 :    
2962 :     usage: $fig->add_chromosomal_clusters($file)
2963 :    
2964 :     The given file is supposed to contain one predicted chromosomal cluster per line (either
2965 :     comma or tab separated pegs). These will be added (to the extent they are new) to those
2966 :     already in $FIG_Config::global/chromosomal_clusters.
2967 :    
2968 :     =cut
2969 :    
2970 :    
2971 :     sub add_chromosomal_clusters {
2972 :     my($self,$file) = @_;
2973 :     my($set,$added);
2974 :    
2975 :     open(TMPCLUST,"<$file")
2976 :     || die "aborted";
2977 :     while (defined($set = <TMPCLUST>))
2978 :     {
2979 :     print STDERR ".";
2980 : golsen 1.44 chomp $set;
2981 : efrank 1.1 $added += $self->add_chromosomal_cluster([split(/[\t,]+/,$set)]);
2982 :     }
2983 :     close(TMPCLUST);
2984 :    
2985 :     if ($added)
2986 :     {
2987 :     my $rdbH = $self->db_handle;
2988 :     $self->export_set("chromosomal_clusters","cluster_id","$FIG_Config::global/chromosomal_clusters");
2989 :     return 1;
2990 :     }
2991 :     return 0;
2992 :     }
2993 :    
2994 :     #=pod
2995 :     #
2996 :     #=head1 export_chromosomal_clusters
2997 :     #
2998 :     #usage: $fig->export_chromosomal_clusters
2999 :     #
3000 :     #Invoking this routine writes the set of chromosomal clusters as known in the
3001 :     #relational DB back to $FIG_Config::global/chromosomal_clusters.
3002 :     #
3003 :     #=cut
3004 :     #
3005 :     sub export_chromosomal_clusters {
3006 :     my($self) = @_;
3007 :    
3008 :     $self->export_set("chromosomal_clusters","cluster_id","$FIG_Config::global/chromosomal_clusters");
3009 :     }
3010 :    
3011 :     sub add_chromosomal_cluster {
3012 :     my($self,$ids) = @_;
3013 :     my($id,$set,%existing,%in,$new,$existing,$new_id);
3014 :    
3015 :     # print STDERR "adding cluster ",join(",",@$ids),"\n";
3016 :     foreach $id (@$ids)
3017 :     {
3018 :     foreach $set ($self->in_sets($id,"chromosomal_clusters","cluster_id"))
3019 :     {
3020 :     $existing{$set} = 1;
3021 :     foreach $id ($self->ids_in_set($set,"chromosomal_clusters","cluster_id"))
3022 :     {
3023 :     $in{$id} = 1;
3024 :     }
3025 :     }
3026 :     }
3027 :     # print &Dumper(\%existing,\%in);
3028 :    
3029 :     $new = 0;
3030 :     foreach $id (@$ids)
3031 :     {
3032 :     if (! $in{$id})
3033 :     {
3034 :     $in{$id} = 1;
3035 :     $new++;
3036 :     }
3037 :     }
3038 :     # print STDERR "$new new ids\n";
3039 :     if ($new)
3040 :     {
3041 :     foreach $existing (keys(%existing))
3042 :     {
3043 :     $self->delete_set($existing,"chromosomal_clusters","cluster_id");
3044 :     }
3045 :     $new_id = $self->next_set("chromosomal_clusters","cluster_id");
3046 :     # print STDERR "adding new cluster $new_id\n";
3047 :     $self->insert_set($new_id,[keys(%in)],"chromosomal_clusters","cluster_id");
3048 :     return 1;
3049 :     }
3050 :     return 0;
3051 :     }
3052 :    
3053 :     ################################# PCH pins ####################################
3054 :    
3055 :     =pod
3056 :    
3057 :     =head1 in_pch_pin_with
3058 :    
3059 :     usage: $fig->in_pch_pin_with($peg)
3060 :    
3061 :     Returns the set of pegs that are believed to be "pinned" to $peg (in the
3062 :     sense that PCHs occur containing these pegs over significant phylogenetic
3063 :     distances).
3064 :    
3065 :     =cut
3066 :    
3067 :     sub in_pch_pin_with {
3068 :     my($self,$peg) = @_;
3069 :     my($set,$id,%in);
3070 :    
3071 :     return $self->in_set_with($peg,"pch_pins","pin");
3072 :     }
3073 :    
3074 :     =pod
3075 :    
3076 :     =head1 add_pch_pins
3077 :    
3078 :     usage: $fig->add_pch_pins($file)
3079 :    
3080 :     The given file is supposed to contain one set of pinned pegs per line (either
3081 :     comma or tab seprated pegs). These will be added (to the extent they are new) to those
3082 :     already in $FIG_Config::global/pch_pins.
3083 :    
3084 :     =cut
3085 :    
3086 :     sub add_pch_pins {
3087 :     my($self,$file) = @_;
3088 :     my($set,$added);
3089 :    
3090 :     open(TMPCLUST,"<$file")
3091 :     || die "aborted";
3092 :     while (defined($set = <TMPCLUST>))
3093 :     {
3094 :     print STDERR ".";
3095 : golsen 1.44 chomp $set;
3096 : efrank 1.1 my @tmp = split(/[\t,]+/,$set);
3097 :     if (@tmp < 200)
3098 :     {
3099 :     $added += $self->add_pch_pin([@tmp]);
3100 :     }
3101 :     }
3102 :     close(TMPCLUST);
3103 :    
3104 :     if ($added)
3105 :     {
3106 :     my $rdbH = $self->db_handle;
3107 :     $self->export_set("pch_pins","pin","$FIG_Config::global/pch_pins");
3108 :     return 1;
3109 :     }
3110 :     return 0;
3111 :     }
3112 :    
3113 :     sub export_pch_pins {
3114 :     my($self) = @_;
3115 :    
3116 :     $self->export_set("pch_pins","pin","$FIG_Config::global/pch_pins");
3117 :     }
3118 :    
3119 :     sub add_pch_pin {
3120 :     my($self,$ids) = @_;
3121 :     my($id,$set,%existing,%in,$new,$existing,$new_id);
3122 :    
3123 :     # print STDERR "adding cluster ",join(",",@$ids),"\n";
3124 :     foreach $id (@$ids)
3125 :     {
3126 :     foreach $set ($self->in_sets($id,"pch_pins","pin"))
3127 :     {
3128 :     $existing{$set} = 1;
3129 :     foreach $id ($self->ids_in_set($set,"pch_pins","pin"))
3130 :     {
3131 :     $in{$id} = 1;
3132 :     }
3133 :     }
3134 :     }
3135 :     # print &Dumper(\%existing,\%in);
3136 :    
3137 :     $new = 0;
3138 :     foreach $id (@$ids)
3139 :     {
3140 :     if (! $in{$id})
3141 :     {
3142 :     $in{$id} = 1;
3143 :     $new++;
3144 :     }
3145 :     }
3146 :    
3147 :     if ($new)
3148 :     {
3149 : overbeek 1.9 if (keys(%in) < 300)
3150 : efrank 1.1 {
3151 : overbeek 1.9 foreach $existing (keys(%existing))
3152 :     {
3153 :     $self->delete_set($existing,"pch_pins","pin");
3154 :     }
3155 :     $new_id = $self->next_set("pch_pins","pin");
3156 :     # print STDERR "adding new pin $new_id\n";
3157 :     $self->insert_set($new_id,[keys(%in)],"pch_pins","pin");
3158 :     }
3159 :     else
3160 :     {
3161 :     $new_id = $self->next_set("pch_pins","pin");
3162 :     # print STDERR "adding new pin $new_id\n";
3163 :     $self->insert_set($new_id,$ids,"pch_pins","pin");
3164 : efrank 1.1 }
3165 :     return 1;
3166 :     }
3167 :     return 0;
3168 :     }
3169 :    
3170 :     ################################# Annotations ####################################
3171 :    
3172 :     =pod
3173 :    
3174 :     =head1 add_annotation
3175 :    
3176 :     usage: $fig->add_annotation($fid,$user,$annotation)
3177 :    
3178 :     $annotation is added as a time-stamped annotation to $peg showing $user as the
3179 :     individual who added the annotation.
3180 :    
3181 :     =cut
3182 :    
3183 :     sub add_annotation {
3184 :     my($self,$feature_id,$user,$annotation) = @_;
3185 :     my($genome);
3186 :    
3187 :     # print STDERR "add: fid=$feature_id user=$user annotation=$annotation\n";
3188 :     if ($genome = $self->genome_of($feature_id))
3189 :     {
3190 :     my $file = "$FIG_Config::organisms/$genome/annotations";
3191 :     my $fileno = $self->file2N($file);
3192 :     my $time_made = time;
3193 : overbeek 1.17 my $ma = ($annotation =~ /^Set master function to/);
3194 :    
3195 : efrank 1.1
3196 :     if (open(TMP,">>$file"))
3197 :     {
3198 :     flock(TMP,LOCK_EX) || confess "cannot lock assigned_functions";
3199 :     seek(TMP,0,2) || confess "failed to seek to the end of the file";
3200 :    
3201 :     my $seek1 = tell TMP;
3202 :     print TMP "$feature_id\n$time_made\n$user\n$annotation", (substr($annotation,-1) eq "\n") ? "" : "\n","//\n";
3203 :     my $seek2 = tell TMP;
3204 :     close(TMP);
3205 : disz 1.60 chmod 02777, $file;
3206 : efrank 1.1 my $ln = $seek2 - $seek1;
3207 :     my $rdbH = $self->db_handle;
3208 : 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 )"))
3209 : efrank 1.1 {
3210 :     return 1;
3211 :     }
3212 :     }
3213 :     }
3214 :     return 0;
3215 :     }
3216 :    
3217 :     =pod
3218 :    
3219 : overbeek 1.33 =head1 merged_related_annotations
3220 :    
3221 :     usage: @annotations = $fig->merged_related_annotations($fids)
3222 :    
3223 :     The set of annotations of a set of PEGs ($fids) is returned as a list of 4-tuples.
3224 :     Each entry in the list is of the form [$fid,$timestamp,$user,$annotation].
3225 :    
3226 :     =cut
3227 :    
3228 :     sub merged_related_annotations {
3229 :     my($self,$fids) = @_;
3230 :     my($fid);
3231 :     my(@ann) = ();
3232 :    
3233 :     foreach $fid (@$fids)
3234 :     {
3235 :     push(@ann,$self->feature_annotations1($fid));
3236 :     }
3237 :     return map { $_->[1] = localtime($_->[1]); $_ } sort { $a->[1] <=> $b->[1] } @ann;
3238 :     }
3239 :    
3240 :     =pod
3241 :    
3242 : efrank 1.1 =head1 feature_annotations
3243 :    
3244 :     usage: @annotations = $fig->feature_annotations($fid)
3245 :    
3246 :     The set of annotations of $fid is returned as a list of 4-tuples. Each entry in the list
3247 :     is of the form [$fid,$timestamp,$user,$annotation].
3248 :    
3249 :     =cut
3250 :    
3251 :    
3252 :     sub feature_annotations {
3253 :     my($self,$feature_id) = @_;
3254 : overbeek 1.33
3255 :     return map { $_->[1] = localtime($_->[1]); $_ } $self->feature_annotations1($feature_id);
3256 :     }
3257 :    
3258 :     sub feature_annotations1 {
3259 :     my($self,$feature_id) = @_;
3260 : overbeek 1.16 my($tuple,$fileN,$seek,$ln,$annotation,$feature_idQ);
3261 : efrank 1.1 my($file,$fh);
3262 :    
3263 :     my $rdbH = $self->db_handle;
3264 :     my $relational_db_response = $rdbH->SQL("SELECT fileno, seek, len FROM annotation_seeks WHERE fid = \'$feature_id\' ");
3265 :     my @annotations = ();
3266 :    
3267 :     foreach $tuple (@$relational_db_response)
3268 :     {
3269 :     ($fileN,$seek,$ln) = @$tuple;
3270 : overbeek 1.16 $annotation = $self->read_annotation($fileN,$seek,$ln);
3271 :     $feature_idQ = quotemeta $feature_id;
3272 :     if ($annotation =~ /^$feature_idQ\n(\d+)\n([^\n]+)\n(.*)/s)
3273 : efrank 1.1 {
3274 : overbeek 1.16 push(@annotations,[$feature_id,$1,$2,$3]);
3275 : efrank 1.1 }
3276 : overbeek 1.16 else
3277 : efrank 1.1 {
3278 : overbeek 1.16 print STDERR "malformed annotation\n$annotation\n";
3279 : efrank 1.1 }
3280 :     }
3281 : overbeek 1.33 return sort { $a->[1] <=> $b->[1] } @annotations;
3282 : overbeek 1.16 }
3283 :    
3284 :     sub read_annotation {
3285 :     my($self,$fileN,$seek,$ln) = @_;
3286 :     my($readN,$readC);
3287 :    
3288 :     my $file = $self->N2file($fileN);
3289 :     my $fh = $self->openF($file);
3290 :     if (! $fh)
3291 :     {
3292 :     confess "could not open annotations for $file";
3293 :     }
3294 :     seek($fh,$seek,0);
3295 : overbeek 1.24 $readN = read($fh,$readC,$ln-3);
3296 :     ($readN == ($ln-3))
3297 : overbeek 1.16 || confess "could not read the block of annotations at $seek for $ln characters; $readN actually read from $file\n$readC";
3298 :     return $readC;
3299 : overbeek 1.17 }
3300 :    
3301 : overbeek 1.21 sub epoch_to_readable {
3302 :     my($epoch) = @_;
3303 :    
3304 :     my($sec,$min,$hr,$dd,$mm,$yr) = localtime($epoch);
3305 :     $mm++;
3306 :     $yr += 1900;
3307 :     return "$mm-$dd-$yr:$hr:$min:$sec";
3308 :     }
3309 :    
3310 : overbeek 1.17 sub assignments_made {
3311 :     my($self,$genomes,$who,$date) = @_;
3312 :     my($relational_db_response,$entry,$fid,$fileno,$seek,$len,$ann);
3313 : overbeek 1.30 my($epoch_date,$when,%sofar,$x);
3314 : overbeek 1.17
3315 : overbeek 1.56 if (! defined($genomes)) { $genomes = [$self->genomes] }
3316 :    
3317 : overbeek 1.17 my %genomes = map { $_ => 1 } @$genomes;
3318 : overbeek 1.19 if ($date =~ /^(\d{1,2})\/(\d{1,2})\/(\d{4})$/)
3319 :     {
3320 :     my($mm,$dd,$yyyy) = ($1,$2,$3);
3321 :     $epoch_date = &Time::Local::timelocal(0,0,0,$dd,$mm-1,$yyyy-1900,0,0,0);
3322 :     }
3323 : overbeek 1.62 elsif ($date =~ /^\d+$/)
3324 :     {
3325 :     $epoch_date = $date;
3326 :     }
3327 : overbeek 1.19 else
3328 :     {
3329 :     $epoch_date = 0;
3330 :     }
3331 :     $epoch_date = defined($epoch_date) ? $epoch_date-1 : 0;
3332 : overbeek 1.17 my @assignments = ();
3333 :     my $rdbH = $self->db_handle;
3334 :     if ($who eq "master")
3335 :     {
3336 : overbeek 1.30 $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE ((ma = \'1\') AND (dateof > $epoch_date))");
3337 : overbeek 1.17 }
3338 :     else
3339 :     {
3340 : overbeek 1.30 $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE (( who = \'$who\' ) AND (dateof > $epoch_date))");
3341 : overbeek 1.17 }
3342 :    
3343 :     if ($relational_db_response && (@$relational_db_response > 0))
3344 :     {
3345 :     foreach $entry (@$relational_db_response)
3346 :     {
3347 : overbeek 1.30 ($fid,$when,$fileno,$seek,$len) = @$entry;
3348 : overbeek 1.17 if (($fid =~ /^fig\|(\d+\.\d+)/) && $genomes{$1})
3349 :     {
3350 : overbeek 1.67 if ($len < 4)
3351 :     {
3352 :     print STDERR "BAD: fid=$fid when=$when fileno=$fileno seek=$seek len=$len\n";
3353 :     next;
3354 :     }
3355 : overbeek 1.17 $ann = $self->read_annotation($fileno,$seek,$len);
3356 :    
3357 :     if (($ann =~ /^(fig\|\d+\.\d+\.peg\.\d+)\n(\d+)\n(\S+)\nSet ([^\n]*)function[^\n]*\n(\S[^\n]+\S)/s) &&
3358 :     (($who eq $3) || (($4 eq "master ") && ($who eq "master"))) &&
3359 : overbeek 1.19 ($2 >= $epoch_date))
3360 : overbeek 1.17 {
3361 : overbeek 1.30 if ((! $sofar{$1}) || (($x = $sofar{$1}) && ($when > $x->[0])))
3362 :     {
3363 :     $sofar{$1} = [$when,$5];
3364 :     }
3365 : overbeek 1.17 }
3366 :     }
3367 :     }
3368 :     }
3369 : overbeek 1.30 @assignments = map { $x = $sofar{$_}; [$_,$x->[1]] } keys(%sofar);
3370 : overbeek 1.17 return @assignments;
3371 : efrank 1.1 }
3372 :    
3373 : overbeek 1.56 sub annotations_made {
3374 :     my($self,$genomes,$who,$date) = @_;
3375 :     my($relational_db_response,$entry,$fid,$fileno,$seek,$len,$ann);
3376 :     my($epoch_date,$when,@annotations);
3377 :    
3378 :     if (! defined($genomes)) { $genomes = [$self->genomes] }
3379 :    
3380 :     my %genomes = map { $_ => 1 } @$genomes;
3381 :     if ($date =~ /^(\d{1,2})\/(\d{1,2})\/(\d{4})$/)
3382 :     {
3383 :     my($mm,$dd,$yyyy) = ($1,$2,$3);
3384 :     $epoch_date = &Time::Local::timelocal(0,0,0,$dd,$mm-1,$yyyy-1900,0,0,0);
3385 :     }
3386 : overbeek 1.62 elsif ($date =~ /^\d+$/)
3387 :     {
3388 :     $epoch_date = $date;
3389 :     }
3390 : overbeek 1.56 else
3391 :     {
3392 :     $epoch_date = 0;
3393 :     }
3394 :     $epoch_date = defined($epoch_date) ? $epoch_date-1 : 0;
3395 :     my @annotations = ();
3396 :     my $rdbH = $self->db_handle;
3397 :     if ($who eq "master")
3398 :     {
3399 :     $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE ((ma = \'1\') AND (dateof > $epoch_date))");
3400 :     }
3401 :     else
3402 :     {
3403 :     $relational_db_response = $rdbH->SQL("SELECT fid, dateof, fileno, seek, len FROM annotation_seeks WHERE (( who = \'$who\' ) AND (dateof > $epoch_date))");
3404 :     }
3405 :    
3406 :     if ($relational_db_response && (@$relational_db_response > 0))
3407 :     {
3408 :     foreach $entry (@$relational_db_response)
3409 :     {
3410 :     ($fid,$when,$fileno,$seek,$len) = @$entry;
3411 :     if (($fid =~ /^fig\|(\d+\.\d+)/) && $genomes{$1})
3412 :     {
3413 :     $ann = $self->read_annotation($fileno,$seek,$len);
3414 :    
3415 : overbeek 1.57 if ($ann =~ /^(fig\|\d+\.\d+\.peg\.\d+)\n(\d+)\n(\S+)\n(.*\S)/s)
3416 : overbeek 1.56 {
3417 :     push(@annotations,[$1,$2,$3,$4]);
3418 :     }
3419 :     }
3420 :     }
3421 :     }
3422 :     return @annotations;
3423 :     }
3424 :    
3425 : efrank 1.1 ################################# Indexing Features and Functional Roles ####################################
3426 :    
3427 :     =pod
3428 :    
3429 :     =head1 search_index
3430 :    
3431 :     usage: ($pegs,$roles) = $fig->search_pattern($pattern)
3432 :    
3433 :     All pegs that "match" $pattern are put into a list, and $pegs will be a
3434 :     pointer to that list.
3435 :    
3436 :     All roles that "match" $pattern are put into a list, and $roles will be a
3437 :     pointer to that list.
3438 :    
3439 :     The notion of "match $pattern" is intentionally left undefined. For now, you
3440 :     will probably get only entries in which each word id $pattern occurs exactly,
3441 :     but that is not a long term commitment.
3442 :    
3443 :     =cut
3444 :    
3445 :     sub search_index {
3446 :     my($self,$pattern) = @_;
3447 :     my($patternQ,@raw,@pegs,@roles);
3448 :    
3449 :     &clean_tmp;
3450 :     $patternQ = $pattern;
3451 :     $patternQ =~ s/\s+/;/g;
3452 :     $patternQ =~ s/\./\\./g;
3453 :    
3454 :     # print STDERR "pattern=$pattern patternQ=$patternQ\n";
3455 :     @raw = `$FIG_Config::ext_bin/glimpse -y -H $FIG_Config::data/Indexes -i -w \'$patternQ\'`;
3456 :     @pegs = sort { &FIG::by_fig_id($a->[0],$b->[0]) }
3457 :     map { $_ =~ s/^\S+:\s+//; [split(/\t/,$_)] }
3458 :     grep { $_ =~ /^\S+peg.index/ } @raw;
3459 :     my %roles = map { $_ =~ s/^\S+:\s+//; $_ => 1} grep { $_ =~ /^\S+role.index/ } @raw;
3460 :     @roles = sort keys(%roles);
3461 :    
3462 :     return ([@pegs],[@roles]);
3463 :     }
3464 :    
3465 :     ################################# Loading Databases ####################################
3466 :    
3467 :    
3468 :     #=pod
3469 :     #
3470 :     #=head1 load_all
3471 :     #
3472 :     #usage: load_all
3473 :     #
3474 :     #This function is supposed to reload all entries into the database and do
3475 :     #whatever is required to properly support indexing of pegs and roles.
3476 :     #
3477 :     #=cut
3478 :    
3479 :     sub load_all {
3480 :    
3481 : overbeek 1.15 &run("index_contigs");
3482 :     &run("compute_genome_counts");
3483 : efrank 1.1 &run("load_features");
3484 :     &run("index_sims");
3485 :     &run("load_peg_mapping");
3486 :     &run("index_translations");
3487 :     &run("add_assertions_of_function");
3488 :     &run("load_protein_families");
3489 :     &run("load_external_orgs");
3490 :     &run("load_chromosomal_clusters");
3491 :     &run("load_pch_pins");
3492 :     &run("index_neighborhoods");
3493 :     &run("index_annotations");
3494 :     &run("load_ec_names");
3495 :     &run("load_kegg");
3496 : overbeek 1.35 &run("load_distances");
3497 : efrank 1.1 &run("make_indexes");
3498 : overbeek 1.70 &run("format_peg_dbs");
3499 : overbeek 1.82 &run("load_links");
3500 : overbeek 1.100 &run("load_bbhs");
3501 : efrank 1.1 }
3502 :    
3503 :     ################################# Automated Assignments ####################################
3504 :    
3505 :     =pod
3506 :    
3507 :     =head1 auto_assign
3508 :    
3509 :     usage: $assignment = &FIG::auto_assign($peg,$seq)
3510 :    
3511 :     This returns an automated assignment for $peg. $seq is optional; if it is not
3512 :     present, then it is assumed that similarities already exist for $peg. $assignment is set
3513 :     to either
3514 :    
3515 :     Function
3516 :     or
3517 :     Function\tW
3518 :    
3519 :     if it is felt that the assertion is pretty weak.
3520 :    
3521 :     =cut
3522 :    
3523 :     sub auto_assign {
3524 :     my($peg,$seq) = @_;
3525 :    
3526 : 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";
3527 : efrank 1.1 # print STDERR $cmd;
3528 :     my(@tmp) = `$cmd`;
3529 :     if ((@tmp == 1) && ($tmp[0] =~ /^\S+\t(\S.*\S)/))
3530 :     {
3531 :     return $1;
3532 :     }
3533 :     else
3534 :     {
3535 :     return "hypothetical protein";
3536 :     }
3537 :     }
3538 :    
3539 :     ################################# Protein Families ####################################
3540 :    
3541 :     =pod
3542 :    
3543 :     =head1 all_protein_families
3544 :    
3545 :     usage: @all = $fig->all_protein_families
3546 :    
3547 :     Returns a list of the ids of all of the protein families currently defined.
3548 :    
3549 :     =cut
3550 :    
3551 :     sub all_protein_families {
3552 :     my($self) = @_;
3553 :    
3554 :     return $self->all_sets("protein_families","family");
3555 :     }
3556 :    
3557 :     =pod
3558 :    
3559 :     =head1 ids_in_family
3560 :    
3561 :     usage: @pegs = $fig->ids_in_family($family)
3562 :    
3563 :     Returns a list of the pegs in $family.
3564 :    
3565 :     =cut
3566 :    
3567 :     sub ids_in_family {
3568 :     my($self,$family) = @_;
3569 :    
3570 :     return $self->ids_in_set($family,"protein_families","family");
3571 :     }
3572 :    
3573 :     =pod
3574 :    
3575 :     =head1 family_function
3576 :    
3577 :     usage: $func = $fig->family_function($family)
3578 :    
3579 :     Returns the putative function of all of the pegs in $family. Remember, we
3580 :     are defining "protein family" as a set of homologous proteins that have the
3581 :     same function.
3582 :    
3583 :     =cut
3584 :    
3585 :     sub family_function {
3586 :     my($self,$family) = @_;
3587 :     my($relational_db_response);
3588 :     my $rdbH = $self->db_handle;
3589 :    
3590 :     defined($family) || confess "family is missing";
3591 :     if (($relational_db_response = $rdbH->SQL("SELECT function FROM family_function WHERE ( family = $family)")) &&
3592 :     (@$relational_db_response >= 1))
3593 :     {
3594 :     return $relational_db_response->[0]->[0];
3595 :     }
3596 :     return "";
3597 :     }
3598 :    
3599 :     =pod
3600 :    
3601 :     =head1 sz_family
3602 :    
3603 :     usage: $n = $fig->sz_family($family)
3604 :    
3605 :     Returns the number of pegs in $family.
3606 :    
3607 :     =cut
3608 :    
3609 :     sub sz_family {
3610 :     my($self,$family) = @_;
3611 :    
3612 :     return $self->sz_set($family,"protein_families","family");
3613 :     }
3614 :    
3615 :     =pod
3616 :    
3617 :     =head1 in_family
3618 :    
3619 :     usage: @pegs = $fig->in_family($family)
3620 :    
3621 :     Returns the pegs in $family.
3622 :    
3623 :     =cut
3624 :    
3625 :     sub in_family {
3626 :     my($self,$id) = @_;
3627 :    
3628 :     my @in = $self->in_sets($id,"protein_families","family");
3629 :     return (@in > 0) ? $in[0] : "";
3630 :     }
3631 :    
3632 :     ################################# Abstract Set Routines ####################################
3633 :    
3634 :     sub all_sets {
3635 :     my($self,$relation,$set_name) = @_;
3636 :     my($relational_db_response);
3637 :    
3638 :     my $rdbH = $self->db_handle;
3639 :    
3640 :     if (($relational_db_response = $rdbH->SQL("SELECT DISTINCT $set_name FROM $relation")) &&
3641 :     (@$relational_db_response >= 1))
3642 :     {
3643 :     return map { $_->[0] } @$relational_db_response;
3644 :     }
3645 :     return ();
3646 :     }
3647 :    
3648 :     sub next_set {
3649 :     my($self,$relation,$set_name) = @_;
3650 :     my($relational_db_response);
3651 :    
3652 :     my $rdbH = $self->db_handle;
3653 :    
3654 :     if (($relational_db_response = $rdbH->SQL("SELECT MAX($set_name) FROM $relation")) &&
3655 :     (@$relational_db_response == 1))
3656 :     {
3657 :     return $relational_db_response->[0]->[0] + 1;
3658 :     }
3659 :     }
3660 :    
3661 :     sub ids_in_set {
3662 :     my($self,$which,$relation,$set_name) = @_;
3663 :     my($relational_db_response);
3664 :    
3665 :     my $rdbH = $self->db_handle;
3666 :     if (defined($which) && ($which =~ /^\d+$/))
3667 :     {
3668 :     if (($relational_db_response = $rdbH->SQL("SELECT id FROM $relation WHERE ( $set_name = $which)")) &&
3669 :     (@$relational_db_response >= 1))
3670 :     {
3671 :     return sort { by_fig_id($a,$b) } map { $_->[0] } @$relational_db_response;
3672 :     }
3673 :     }
3674 :     return ();
3675 :     }
3676 :    
3677 :     sub in_sets {
3678 :     my($self,$id,$relation,$set_name) = @_;
3679 :     my($relational_db_response);
3680 :    
3681 :     my $rdbH = $self->db_handle;
3682 :    
3683 :     if (($relational_db_response = $rdbH->SQL("SELECT $set_name FROM $relation WHERE ( id = \'$id\' )")) &&
3684 :     (@$relational_db_response >= 1))
3685 :     {
3686 :     return map { $_->[0] } @$relational_db_response;
3687 :     }
3688 :     return ();
3689 :     }
3690 :    
3691 :     sub sz_set {
3692 :     my($self,$which,$relation,$set_name) = @_;
3693 :     my($relational_db_response);
3694 :    
3695 :     my $rdbH = $self->db_handle;
3696 :    
3697 :     if (($relational_db_response = $rdbH->SQL("SELECT COUNT(*) FROM $relation WHERE ( $set_name = $which)")) &&
3698 :     (@$relational_db_response == 1))
3699 :     {
3700 :     return $relational_db_response->[0]->[0];
3701 :     }
3702 :     return 0;
3703 :     }
3704 :    
3705 :     sub delete_set {
3706 :     my($self,$set,$relation,$set_name) = @_;
3707 :    
3708 :     # print STDERR "deleting set $set\n";
3709 :     my $rdbH = $self->db_handle;
3710 :    
3711 :     return $rdbH->SQL("DELETE FROM $relation WHERE ( $set_name = $set )");
3712 :     }
3713 :    
3714 :     sub insert_set {
3715 :     my($self,$set,$ids,$relation,$set_name) = @_;
3716 :     my($id);
3717 :    
3718 :     # print STDERR "inserting set $set containing ",join(",",@$ids),"\n";
3719 :     my $rdbH = $self->db_handle;
3720 :    
3721 : overbeek 1.23 my @ids = grep { length($_) < 255 } @$ids;
3722 :     if (@ids < 2) { return 0 }
3723 :    
3724 : efrank 1.1 my $rc = 1;
3725 : overbeek 1.23 foreach $id (@ids)
3726 : efrank 1.1 {
3727 :     if (! $rdbH->SQL("INSERT INTO $relation ( $set_name,id ) VALUES ( $set,\'$id\' )"))
3728 :     {
3729 :     $rc = 0;
3730 :     }
3731 :     }
3732 :     # print STDERR " rc=$rc\n";
3733 :     return $rc;
3734 :     }
3735 :    
3736 :     sub in_set_with {
3737 :     my($self,$peg,$relation,$set_name) = @_;
3738 :     my($set,$id,%in);
3739 :    
3740 :     foreach $set ($self->in_sets($peg,$relation,$set_name))
3741 :     {
3742 :     foreach $id ($self->ids_in_set($set,$relation,$set_name))
3743 :     {
3744 :     $in{$id} = 1;
3745 :     }
3746 :     }
3747 :     return sort { &by_fig_id($a,$b) } keys(%in);
3748 :     }
3749 :    
3750 :    
3751 :     sub export_set {
3752 :     my($self,$relation,$set_name,$file) = @_;
3753 :     my($pair);
3754 :    
3755 :     my $rdbH = $self->db_handle;
3756 :     my $relational_db_response = $rdbH->SQL("SELECT $set_name, id FROM $relation");
3757 :    
3758 :     open(TMP,">$file")
3759 :     || die "could not open $file";
3760 :     flock(TMP,LOCK_EX) || confess "cannot lock $file";
3761 :     seek(TMP,0,2) || confess "failed to seek to the end of the file";
3762 :    
3763 :     foreach $pair (sort { ($a->[0] <=> $b->[0]) or &by_fig_id($a->[1],$b->[1]) } @$relational_db_response)
3764 :     {
3765 :     print TMP join("\t",@$pair),"\n";
3766 :     }
3767 :     close(TMP);
3768 :     return 1;
3769 :     }
3770 :    
3771 :     ################################# KEGG Stuff ####################################
3772 :    
3773 :    
3774 :     =pod
3775 :    
3776 :     =head1 all_compounds
3777 :    
3778 :     usage: @compounds = $fig->all_compounds
3779 :    
3780 :     Returns a list containing all of the KEGG compounds.
3781 :    
3782 :     =cut
3783 :    
3784 :     sub all_compounds {
3785 :     my($self) = @_;
3786 :    
3787 :     my $rdbH = $self->db_handle;
3788 :     my $relational_db_response = $rdbH->SQL("SELECT DISTINCT cid FROM comp_name");
3789 :     if (@$relational_db_response > 0)
3790 :     {
3791 :     return sort map { $_->[0] } @$relational_db_response;
3792 :     }
3793 :     return ();
3794 :     }
3795 :    
3796 :     =pod
3797 :    
3798 :     =head1 names_of_compound
3799 :    
3800 :     usage: @names = $fig->names_of_compound
3801 :    
3802 :     Returns a list containing all of the names assigned to the KEGG compounds. The list
3803 :     will be ordered as given by KEGG.
3804 :    
3805 :     =cut
3806 :    
3807 :     sub names_of_compound {
3808 :     my($self,$cid) = @_;
3809 :    
3810 :     my $rdbH = $self->db_handle;
3811 :     my $relational_db_response = $rdbH->SQL("SELECT pos,name FROM comp_name where cid = \'$cid\'");
3812 :     if (@$relational_db_response > 0)
3813 :     {
3814 :     return map { $_->[1] } sort { $a->[0] <=> $b->[0] } @$relational_db_response;
3815 :     }
3816 :     return ();
3817 :     }
3818 :    
3819 :     =pod
3820 :    
3821 :     =head1 comp2react
3822 :    
3823 :    
3824 :     usage: @rids = $fig->comp2react($cid)
3825 :    
3826 :     Returns a list containing all of the reaction IDs for reactions that take $cid
3827 :     as either a substrate or a product.
3828 :    
3829 :     =cut
3830 :    
3831 :     sub comp2react {
3832 :     my($self,$cid) = @_;
3833 :    
3834 :     my $rdbH = $self->db_handle;
3835 :     my $relational_db_response = $rdbH->SQL("SELECT rid FROM reaction_to_compound where cid = \'$cid\'");
3836 :     if (@$relational_db_response > 0)
3837 :     {
3838 :     return sort map { $_->[0] } @$relational_db_response;
3839 :     }
3840 :     return ();
3841 :     }
3842 :    
3843 :     =pod
3844 :    
3845 :     =head1 cas
3846 :    
3847 :     usage: $cas = $fig->cas($cid)
3848 :    
3849 :     Returns the CAS ID for the compound, if known.
3850 :    
3851 :     =cut
3852 :    
3853 :     sub cas {
3854 :     my($self,$cid) = @_;
3855 :    
3856 :     my $rdbH = $self->db_handle;
3857 :     my $relational_db_response = $rdbH->SQL("SELECT cas FROM comp_cas where cid = \'$cid\'");
3858 :     if (@$relational_db_response == 1)
3859 :     {
3860 :     return $relational_db_response->[0]->[0];
3861 :     }
3862 :     return "";
3863 :     }
3864 :    
3865 :     =pod
3866 :    
3867 :     =head1 cas_to_cid
3868 :    
3869 :     usage: $cid = $fig->cas_to_cid($cas)
3870 :    
3871 :     Returns the compound id (cid), given the CAS ID.
3872 :    
3873 :     =cut
3874 :    
3875 :     sub cas_to_cid {
3876 :     my($self,$cas) = @_;
3877 :    
3878 :     my $rdbH = $self->db_handle;
3879 :     my $relational_db_response = $rdbH->SQL("SELECT cid FROM comp_cas where cas = \'$cas\'");
3880 :     if (@$relational_db_response == 1)
3881 :     {
3882 :     return $relational_db_response->[0]->[0];
3883 :     }
3884 :     return "";
3885 :     }
3886 :    
3887 :     =pod
3888 :    
3889 :     =head1 all_reactions
3890 :    
3891 :     usage: @rids = $fig->all_reactions
3892 :    
3893 :     Returns a list containing all of the KEGG reaction IDs.
3894 :    
3895 :     =cut
3896 :    
3897 :     sub all_reactions {
3898 :     my($self) = @_;
3899 :    
3900 :     my $rdbH = $self->db_handle;
3901 :     my $relational_db_response = $rdbH->SQL("SELECT DISTINCT rid FROM reaction_to_compound");
3902 :     if (@$relational_db_response > 0)
3903 :     {
3904 :     return sort map { $_->[0] } @$relational_db_response;
3905 :     }
3906 :     return ();
3907 :     }
3908 :    
3909 :     =pod
3910 :    
3911 :     =head1 reversible
3912 :    
3913 :     usage: $rev = $fig->reversible($rid)
3914 :    
3915 :     Returns true iff the reactions had a "main direction" designated as "<=>";
3916 :    
3917 :     =cut
3918 :    
3919 :     sub reversible {
3920 :     my($self,$rid) = @_;
3921 :    
3922 :     my $rdbH = $self->db_handle;
3923 :     my $relational_db_response = $rdbH->SQL("SELECT reversible FROM reversible where rid = \'$rid\'");
3924 :     if (@$relational_db_response == 1)
3925 :     {
3926 :     return $relational_db_response->[0]->[0];
3927 :     }
3928 :     return 1;
3929 :     }
3930 :    
3931 :     =pod
3932 :    
3933 :     =head1 reaction2comp
3934 :    
3935 :     usage: @tuples = $fig->reaction2comp($rid,$which)
3936 :    
3937 :     Returns the "substrates" iff $which == 0. In any event (i.e., whether you ask for substrates
3938 :     or products), you get back a list of 3-tuples. Each 3-tuple will contain
3939 :    
3940 :     [$cid,$stoich,$main]
3941 :    
3942 :     Stoichiometry is normally numeric, but can be things like "n" or "(n+1)".
3943 :     $main is 1 iff the compound is considered "main" or "connectable".
3944 :    
3945 :     =cut
3946 :    
3947 :     sub reaction2comp {
3948 :     my($self,$rid,$which) = @_;
3949 :    
3950 :     my $rdbH = $self->db_handle;
3951 :     my $relational_db_response = $rdbH->SQL("SELECT cid,stoich,main FROM reaction_to_compound where rid = \'$rid\' and setn = \'$which\'");
3952 :     if (@$relational_db_response > 0)
3953 :     {
3954 :     return sort { $a->[0] cmp $b->[0] } map { $_->[1] =~ s/\s+//g; $_ } @$relational_db_response;
3955 :     }
3956 :     return ();
3957 :     }
3958 :    
3959 :     =pod
3960 :    
3961 :     =head1 catalyzed_by
3962 :    
3963 :     usage: @ecs = $fig->catalyzed_by($rid)
3964 :    
3965 :     Returns the ECs that are reputed to catalyze the reaction. Note that we are currently
3966 :     just returning the ECs that KEGG gives. We need to handle the incompletely specified forms
3967 :     (e.g., 1.1.1.-), but we do not do it yet.
3968 :    
3969 :     =cut
3970 :    
3971 :     sub catalyzed_by {
3972 :     my($self,$rid) = @_;
3973 :    
3974 :     my $rdbH = $self->db_handle;
3975 :     my $relational_db_response = $rdbH->SQL("SELECT role FROM reaction_to_enzyme where rid = \'$rid\'");
3976 :     if (@$relational_db_response > 0)
3977 :     {
3978 :     return sort map { $_->[0] } @$relational_db_response;
3979 :     }
3980 :     return ();
3981 :     }
3982 :    
3983 :     =pod
3984 :    
3985 :     =head1 catalyzes
3986 :    
3987 :     usage: @ecs = $fig->catalyzes($role)
3988 :    
3989 :     Returns the rids of the reactions catalyzed by the "role" (normally an EC).
3990 :    
3991 :     =cut
3992 :    
3993 :     sub catalyzes {
3994 :     my($self,$role) = @_;
3995 :    
3996 :     my $rdbH = $self->db_handle;
3997 :     my $relational_db_response = $rdbH->SQL("SELECT rid FROM reaction_to_enzyme where role = \'$role\'");
3998 :     if (@$relational_db_response > 0)
3999 :     {
4000 :     return sort map { $_->[0] } @$relational_db_response;
4001 :     }
4002 :     return ();
4003 :     }
4004 :    
4005 :    
4006 :     =pod
4007 :    
4008 :     =head1 displayable_reaction
4009 :    
4010 :     usage: $display_format = $fig->displayable_reaction($rid)
4011 :    
4012 :     Returns a string giving the displayable version of a reaction.
4013 :    
4014 :     =cut
4015 :    
4016 :     sub displayable_reaction {
4017 :     my($self,$rid) = @_;
4018 :    
4019 :     my @tmp = `grep $rid $FIG_Config::data/KEGG/reaction_name.lst`;
4020 :     if (@tmp > 0)
4021 :     {
4022 : golsen 1.44 chomp $tmp[0];
4023 : efrank 1.1 return $tmp[0];
4024 :     }
4025 :     return $rid;
4026 :     }
4027 :    
4028 :     =pod
4029 :    
4030 :     =head1 all_maps
4031 :    
4032 :     usage: @maps = $fig->all_maps
4033 :    
4034 :     Returns a list containing all of the KEGG maps that the system knows about (the
4035 :     maps need to be periodically updated).
4036 :    
4037 :     =cut
4038 :    
4039 :     sub all_maps {
4040 :     my($self,$ec) = @_;
4041 :    
4042 :     my $rdbH = $self->db_handle;
4043 :     my $relational_db_response = $rdbH->SQL("SELECT DISTINCT map FROM ec_map ");
4044 :     if (@$relational_db_response > 0)
4045 :     {
4046 :     return map { $_->[0] } @$relational_db_response;
4047 :     }
4048 :     return ();
4049 :     }
4050 :    
4051 :     =pod
4052 :    
4053 :     =head1 ec_to_maps
4054 :    
4055 :     usage: @maps = $fig->ec_to_maps($ec)
4056 :    
4057 :     Returns the set of maps that contain $ec as a functional role. $ec is usually an EC number,
4058 :     but in the more general case, it can be a functional role.
4059 :    
4060 :     =cut
4061 :    
4062 :     sub ec_to_maps {
4063 :     my($self,$ec) = @_;
4064 :    
4065 :     my $rdbH = $self->db_handle;
4066 :     my $relational_db_response = $rdbH->SQL("SELECT map FROM ec_map WHERE ( ec = \'$ec\' )");
4067 :     if (@$relational_db_response > 0)
4068 :     {
4069 :     return map { $_->[0] } @$relational_db_response;
4070 :     }
4071 :     return ();
4072 :     }
4073 :    
4074 :    
4075 :     =pod
4076 :    
4077 :     =head1 map_to_ecs
4078 :    
4079 :     usage: @ecs = $fig->map_to_ecs($map)
4080 :    
4081 :     Returns the set of functional roles (usually ECs) that are contained in the functionality
4082 :     depicted by $map.
4083 :    
4084 :     =cut
4085 :    
4086 :     sub map_to_ecs {
4087 :     my($self,$map) = @_;
4088 :    
4089 :     my $rdbH = $self->db_handle;
4090 :     my $relational_db_response = $rdbH->SQL("SELECT ec FROM ec_map WHERE ( map = \'$map\' )");
4091 :     if (@$relational_db_response > 0)
4092 :     {
4093 :     return map { $_->[0] } @$relational_db_response;
4094 :     }
4095 :     return ();
4096 :     }
4097 :    
4098 :     =pod
4099 :    
4100 :     =head1 map_name
4101 :    
4102 :     usage: $name = $fig->map_name($map)
4103 :    
4104 :     Returns the descriptive name covering the functionality depicted by $map.
4105 :    
4106 :     =cut
4107 :    
4108 :     sub map_name {
4109 :     my($self,$map) = @_;
4110 :    
4111 :     my $rdbH = $self->db_handle;
4112 :     my $relational_db_response = $rdbH->SQL("SELECT mapname FROM map_name WHERE ( map = \'$map\' )");
4113 :     if (@$relational_db_response == 1)
4114 :     {
4115 :     return $relational_db_response->[0]->[0];
4116 :     }
4117 :     return "";
4118 :     }
4119 :    
4120 :     ################################# Functional Roles ####################################
4121 :    
4122 :     =pod
4123 :    
4124 :     =head1 neighborhood_of_role
4125 :    
4126 :     usage: @roles = $fig->neighborhood_of_role($role)
4127 :    
4128 :     Returns a list of functional roles that we consider to be "the neighborhood" of $role.
4129 :    
4130 :     =cut
4131 :    
4132 :     sub neighborhood_of_role {
4133 :     my($self,$role) = @_;
4134 :     my($readC);
4135 :    
4136 :     my $file = "$FIG_Config::global/role.neighborhoods";
4137 :     my $rdbH = $self->db_handle;
4138 :     my $roleQ = quotemeta $role;
4139 :     my $relational_db_response = $rdbH->SQL("SELECT seek, len FROM neigh_seeks WHERE role = \'$roleQ\' ");
4140 :     if (@$relational_db_response == 1)
4141 :     {
4142 :     my($seek,$ln) = @{$relational_db_response->[0]};
4143 :     my $fh = $self->openF($file);
4144 :     seek($fh,$seek,0);
4145 :     my $readN = read($fh,$readC,$ln-1);
4146 :     ($readN == ($ln-1))
4147 :     || confess "could not read the block of sims at $seek for $ln - 1 characters; $readN actually read from $file\n$readC";
4148 :     return grep { $_ && ($_ !~ /^\/\//) } split(/\n/,$readC);
4149 :     }
4150 :     return ();
4151 :     }
4152 :    
4153 :     =pod
4154 :    
4155 :     =head1 roles_of_function
4156 :    
4157 :     usage: @roles = $fig->roles_of_function($func)
4158 :    
4159 :     Returns a list of the functional roles implemented by $func.
4160 :    
4161 :     =cut
4162 :    
4163 :     sub roles_of_function {
4164 : overbeek 1.99 my $func = (@_ == 1) ? $_[0] : $_[1];
4165 : efrank 1.1
4166 :     return (split(/\s*[\/;]\s+/,$func),($func =~ /\d+\.\d+\.\d+\.\d+/g));
4167 :     }
4168 :    
4169 :     =pod
4170 :    
4171 :     =head1 seqs_with_role
4172 :    
4173 :     usage: @pegs = $fig->seqs_with_role($role,$who)
4174 :    
4175 :     Returns a list of the pegs that implement $role. If $who is not given, it
4176 :     defaults to "master". The system returns all pegs with an assignment made by
4177 :     either "master" or $who (if it is different than the master) that implement $role.
4178 :     Note that this includes pegs for which the "master" annotation disagrees with that
4179 :     of $who, the master's implements $role, and $who's does not.
4180 :    
4181 :     =cut
4182 :    
4183 :     sub seqs_with_role {
4184 : overbeek 1.26 my($self,$role,$who,$genome) = @_;
4185 :     my($relational_db_response,$query);
4186 : efrank 1.1
4187 : overbeek 1.32 my $roleQ = quotemeta $role;
4188 :    
4189 : efrank 1.1 $who = $who ? $who : "master";
4190 :     my $rdbH = $self->db_handle;
4191 :    
4192 :     my $who_cond;
4193 :     if ($who eq "master")
4194 :     {
4195 :     $who_cond = "( made_by = \'master\' OR made_by = \'unknown\' )";
4196 :     }
4197 :     else
4198 :     {
4199 :     $who_cond = "( made_by = \'master\' OR made_by = \'$who\' OR made_by = \'unknown\')";
4200 :     }
4201 : overbeek 1.26
4202 :     if (! $genome)
4203 :     {
4204 : overbeek 1.32 $query = "SELECT distinct prot FROM roles WHERE (( role = \'$roleQ\' ) AND $who_cond )";
4205 : overbeek 1.26 }
4206 :     else
4207 :     {
4208 : overbeek 1.32 $query = "SELECT distinct prot FROM roles WHERE (( role = \'$roleQ\' ) AND $who_cond AND (org = \'$genome\'))";
4209 : overbeek 1.26 }
4210 : efrank 1.1 return (($relational_db_response = $rdbH->SQL($query)) && (@$relational_db_response >= 1)) ?
4211 :     map { $_->[0] } @$relational_db_response : ();
4212 :     }
4213 :    
4214 :     =pod
4215 :    
4216 :     =head1 seqs_with_roles_in_genomes
4217 :    
4218 :     usage: $result = $fig->seqs_with_roles_in_genomes($genomes,$roles,$made_by)
4219 :    
4220 :     This routine takes a pointer to a list of genomes ($genomes) and a pointer to a list of
4221 :     roles ($roles) and looks up all of the sequences that connect to those roles according
4222 :     to either the master assignments or those made by $made_by. Again, you will get assignments
4223 :     for which the "master" assignment connects, but the $made_by does not.
4224 :    
4225 :     A hash is returned. The keys to the hash are genome IDs for which at least one sequence
4226 :     was found. $result->{$genome} will itself be a hash, assuming that at least one sequence
4227 :     was found for $genome. $result->{$genome}->{$role} will be set to a pointer to a list of
4228 :     2-tuples. Each 2-tuple will contain [$peg,$function], where $function is the one for
4229 :     $made_by (which may not be the one that connected).
4230 :    
4231 :     =cut
4232 :    
4233 :     sub seqs_with_roles_in_genomes {
4234 :     my($self,$genomes,$roles,$made_by) = @_;
4235 :     my($genome,$role,$roleQ,$role_cond,$made_by_cond,$query,$relational_db_response,$peg,$genome_cond,$hit);
4236 :     my $rdbH = $self->db_handle;
4237 :     my $result = {}; # foreach $genome ($self->genomes) { $result->{$genome} = {} }
4238 :     if (! $made_by) { $made_by = 'master' }
4239 :     if ((@$genomes > 0) && (@$roles > 0))
4240 :     {
4241 :     $genome_cond = "(" . join(" OR ",map { "( org = \'$_\' )" } @$genomes) . ")";
4242 :     $role_cond = "(" . join(" OR ",map { $roleQ = quotemeta $_; "( role = \'$roleQ\' )" } @$roles) . ")";
4243 :     $made_by_cond = ($made_by eq 'master') ? "(made_by = 'master')" : "(made_by = 'master' OR made_by = '$made_by')";
4244 :     $query = "SELECT distinct prot, role FROM roles WHERE ( $made_by_cond AND $genome_cond AND $role_cond )";
4245 :     if (($relational_db_response = $rdbH->SQL($query)) && (@$relational_db_response >= 1))
4246 :     {
4247 :     foreach $hit (@$relational_db_response)
4248 :     {
4249 :     ($peg,$role) = @$hit;
4250 :     $genome = $self->genome_of($peg);
4251 :     push(@{ $result->{$genome}->{$role} },[$peg,scalar $self->function_of($peg,$made_by)]);
4252 :     }
4253 :     }
4254 :     }
4255 :     return $result;
4256 :     }
4257 :    
4258 :     =pod
4259 :    
4260 :     =head1 largest_clusters
4261 :    
4262 :     usage: @clusters = $fig->largest_clusters($roles,$user)
4263 :    
4264 : mkubal 1.54 This routine can be used to find the largest clusters containing some of the
4265 : efrank 1.1 designated set of roles. A list of clusters is returned. Each cluster is a pointer to
4266 :     a list of pegs.
4267 :    
4268 :     =cut
4269 :    
4270 :     sub largest_clusters {
4271 :     my($self,$roles,$user,$sort_by_unique_functions) = @_;
4272 :     my($genome,$x,$role,$y,$peg,$loc,$contig,$beg,$end,%pegs,@pegs,$i,$j);
4273 :    
4274 :     my $ss = $self->seqs_with_roles_in_genomes([$self->genomes],$roles,$user);
4275 :     my @clusters = ();
4276 :    
4277 :     foreach $genome (keys(%$ss))
4278 :     {
4279 :     my %pegs;
4280 :     $x = $ss->{$genome};
4281 :     foreach $role (keys(%$x))
4282 :     {
4283 :     $y = $x->{$role};
4284 :     foreach $peg (map { $_->[0] } @$y)
4285 :     {
4286 :     if ($loc = $self->feature_location($peg))
4287 :     {
4288 :     ($contig,$beg,$end) = &FIG::boundaries_of($loc);
4289 :     $pegs{$peg} = [$peg,$contig,int(($beg + $end) / 2)];
4290 :     }
4291 :     }
4292 :     }
4293 :    
4294 :     @pegs = sort { ($pegs{$a}->[1] cmp $pegs{$b}->[1]) or ($pegs{$a}->[2] <=> $pegs{$b}->[2]) } keys(%pegs);
4295 :     $i = 0;
4296 :     while ($i < $#pegs)
4297 :     {
4298 :     for ($j=$i+1; ($j < @pegs) && &close_enough_locs($pegs{$pegs[$j-1]},$pegs{$pegs[$j]}); $j++) {}
4299 :     if ($j > ($i+1))
4300 :     {
4301 :     push(@clusters,[@pegs[$i..$j-1]]);
4302 :     }
4303 :     $i = $j;
4304 :     }
4305 :     }
4306 :     if ($sort_by_unique_functions)
4307 :     {
4308 :     @clusters = sort { $self->unique_functions($b,$user) <=> $self->unique_functions($a,$user) } @clusters;
4309 :     }
4310 :     else
4311 :     {
4312 :     @clusters = sort { @$b <=> @$a } @clusters;
4313 :     }
4314 :     return @clusters;
4315 :     }
4316 :    
4317 :     sub unique_functions {
4318 :     my($self,$pegs,$user) = @_;
4319 :     my($peg,$func,%seen);
4320 :    
4321 :     foreach $peg (@$pegs)
4322 :     {
4323 :     if ($func = $self->function_of($peg,$user))
4324 :     {
4325 :     $seen{$func} = 1;
4326 :     }
4327 :     }
4328 :     return scalar keys(%seen);
4329 :     }
4330 :    
4331 :     sub close_enough_locs {
4332 :     my($x,$y) = @_;
4333 :    
4334 :     return (($x->[1] eq $y->[1]) && (abs($x->[2] - $y->[2]) < 5000));
4335 :     }
4336 :    
4337 : overbeek 1.59 sub candidates_for_role {
4338 :     my($self,$role,$genome,$cutoff,$user) = @_;
4339 :     my($peg);
4340 : overbeek 1.64
4341 : overbeek 1.59 $user = $user ? $user : "master";
4342 :    
4343 :     my @cand = map { $_->[0] }
4344 :     sort { $a->[1] <=> $b->[1] }
4345 :     map { $peg = $_; [$peg,$self->crude_estimate_of_distance($genome,&FIG::genome_of($peg))] }
4346 :     $self->seqs_with_role($role,$user);
4347 :    
4348 : overbeek 1.64 return $self->candidates_for_role_from_known($genome,$cutoff,\@cand);
4349 :     }
4350 :    
4351 :     sub candidates_for_role_from_known {
4352 :     my($self,$genome,$cutoff,$known) = @_;
4353 :     my($peg);
4354 :    
4355 :     my @cand = @$known;
4356 : overbeek 1.59 my $hits = {};
4357 :     my $seen = {};
4358 : overbeek 1.68 my $how_many = (@cand > 10) ? 9 : scalar @cand;
4359 :     &try_to_locate($self,$genome,$hits,[@cand[0..$how_many]],$seen,$cutoff);
4360 : overbeek 1.59 if (keys(%$hits) == 0)
4361 :     {
4362 :     splice(@cand,0,$how_many+1);
4363 :     &try_to_locate($self,$genome,$hits,\@cand,$seen,$cutoff);
4364 :     }
4365 :     return sort {$hits->{$a}->[0] <=> $hits->{$b}->[0]} keys(%$hits);
4366 :     }
4367 :    
4368 :     sub try_to_locate {
4369 :     my($self,$genome,$hits,$to_try,$seen,$cutoff) = @_;
4370 :     my($prot,$id2,$psc,$id2a,$x,$sim);
4371 :    
4372 :     if (! $cutoff) { $cutoff = 1.0e-5 }
4373 :    
4374 :     foreach $prot (@$to_try)
4375 :     {
4376 :     if (! $seen->{$prot})
4377 :     {
4378 :     if (($prot =~ /^fig\|(\d+\.\d+)/) && ($1 eq $genome))
4379 :     {
4380 :     $hits->{$prot} = [0,$prot];
4381 :     }
4382 :     else
4383 :     {
4384 :     foreach $sim ($self->sims($prot,1000,$cutoff,"raw",0))
4385 :     {
4386 :     $id2 = $sim->id2;
4387 :     $psc = $sim->psc;
4388 :     foreach $id2a (map { $_->[0] } $self->mapped_prot_ids($id2))
4389 :     {
4390 :     if (($id2a =~ /^fig\|(\d+\.\d+)/) && ($1 eq $genome))
4391 :     {
4392 :     $x = $hits->{$id2a};
4393 :     if ((! $x) || ($x->[0] > $psc))
4394 :     {
4395 :     $hits->{$id2a} = [$sim->psc,$prot];
4396 :     }
4397 :     }
4398 :     elsif ($psc < 1.0e-20)
4399 :     {
4400 :     {
4401 :     $seen->{$id2a} = 1;
4402 :     }
4403 :     }
4404 :     }
4405 :    
4406 :     }
4407 :     }
4408 :     }
4409 :     }
4410 :     }
4411 :    
4412 : overbeek 1.65
4413 :     =pod
4414 :    
4415 :     =head1 best_bbh_candidates
4416 :    
4417 :     usage: @candidates = $fig->best_bbh_candidates($genome,$cutoff,$requested,$known)
4418 :    
4419 :     This routine returns a list of up to $requested candidates from $genome. A candidate is a BBH
4420 : overbeek 1.100 against one of the PEGs in genomes from the list given by@$known.
4421 :     Each entry in the list is a 3-tuple:
4422 : overbeek 1.65
4423 :     [CandidatePEG,KnownBBH,Pscore]
4424 :    
4425 :     =cut
4426 :    
4427 :     sub best_bbh_candidates {
4428 : overbeek 1.71 my($self,$genome,$cutoff,$requested,$known,$frac_match) = @_;
4429 : overbeek 1.64 my($i,$j,$k,$sim,@sims,$peg,$id2,$genome2,$sim_back);
4430 : overbeek 1.67 my($bbh,%seen,%computed_sims,$genome1);
4431 : overbeek 1.64
4432 : overbeek 1.71 $frac_match = defined($frac_match) ? $frac_match : 0.7;
4433 : overbeek 1.64 my @got = ();
4434 :     my @cand = $self->candidates_for_role_from_known($genome,$cutoff,$known);
4435 :     if (@cand > 0)
4436 :     {
4437 : overbeek 1.67 my %genomes = map { $genome1 = &FIG::genome_of($_); $genome1 => 1 } @$known;
4438 : overbeek 1.64 my %pegs = map { $_ => 1 } @$known;
4439 :     for ($i=0; (@got < $requested) && ($i < @cand); $i++)
4440 :     {
4441 :     $peg = $cand[$i];
4442 :     undef %seen;
4443 :     @sims = grep { $genomes{&FIG::genome_of($_->id2)} } $self->sims($peg,1000,$cutoff,"fig");
4444 :     $bbh = 0;
4445 :     for ($j=0; (! $bbh) && ($j < @sims); $j++)
4446 :     {
4447 :     $sim = $sims[$j];
4448 :     $id2 = $sim->id2;
4449 :     $genome2 = &FIG::genome_of($id2);
4450 :     if (! $seen{$genome2})
4451 :     {
4452 :     if ($pegs{$id2})
4453 :     {
4454 :     if (! defined($sim_back = $computed_sims{$id2}))
4455 :     {
4456 :     my @sims_back = $self->sims($id2,1000,$cutoff,"fig");
4457 :     for ($k=0; ($k < @sims_back) && (&FIG::genome_of($sims_back[$k]->id2) ne $genome); $k++) {}
4458 :     if ($k < @sims_back)
4459 :     {
4460 :     $sim_back = $computed_sims{$id2} = $sims_back[$k];
4461 :     }
4462 :     else
4463 :     {
4464 :     $sim_back = $computed_sims{$id2} = 0;
4465 :     }
4466 :     }
4467 :     if ($sim_back)
4468 :     {
4469 : overbeek 1.71 if ($self->ok_match($sim_back,$frac_match))
4470 : overbeek 1.64 {
4471 : overbeek 1.65 $bbh = [$id2,$sim_back->psc];
4472 : overbeek 1.64 }
4473 :     }
4474 :     }
4475 :     $seen{$genome2} = 1;
4476 :     }
4477 :     }
4478 :    
4479 :     if ($bbh)
4480 :     {
4481 : overbeek 1.65 push(@got,[$peg,@$bbh]);
4482 : overbeek 1.64 }
4483 :     }
4484 :     }
4485 :     return @got;
4486 :     }
4487 :    
4488 :    
4489 :     sub ok_match {
4490 : overbeek 1.71 my($self,$sim,$frac_match) = @_;
4491 : overbeek 1.64
4492 :     my $ln1 = $sim->ln1;
4493 :     my $ln2 = $sim->ln2;
4494 :     my $b1 = $sim->b1;
4495 :     my $e1 = $sim->e1;
4496 :     my $b2 = $sim->b2;
4497 :     my $e2 = $sim->e2;
4498 :    
4499 : overbeek 1.71 return (((($e1 - $b1) / $ln1) >= $frac_match) &&
4500 :     ((($e2 - $b2) / $ln2) >= $frac_match))
4501 :     }
4502 :    
4503 :     sub external_calls {
4504 :     my($self,$pegs) = @_;
4505 : overbeek 1.72 my($peg,$func);
4506 : overbeek 1.71
4507 :     open(TMP,">/tmp/pegs.$$") || die "could not open /tmp/pegs.$$";
4508 :     foreach $peg (@$pegs)
4509 :     {
4510 :     print TMP "$peg\n";
4511 :     }
4512 :     close(TMP);
4513 :     open(TMP,">/tmp/parms.$$") || die "could not open /tmp/parms.$$";
4514 :     print TMP "no_fig\t1\n";
4515 :     close(TMP);
4516 :    
4517 : overbeek 1.72 my %call = map { chop; ($peg,$func) = split(/\t/,$_) }
4518 :     `$FIG_Config::bin/auto_assign /tmp/parms.$$ < /tmp/pegs.$$ 2> /dev/null | $FIG_Config::bin/make_calls`;
4519 : overbeek 1.71 unlink("/tmp/pegs.$$","/tmp/parms.$$");
4520 : overbeek 1.72 return map { $call{$_} ? [$_,$call{$_}] : [$_,"hypothetical protein"] } @$pegs;
4521 : overbeek 1.71 }
4522 :    
4523 :     use SameFunc;
4524 :    
4525 :     sub same_func {
4526 :     my($self,$f1,$f2) = @_;
4527 :    
4528 :     return &SameFunc::same_func($f1,$f2);
4529 : overbeek 1.64 }
4530 :    
4531 : efrank 1.1 ################################# DNA sequence Stuff ####################################
4532 :    
4533 :     =pod
4534 :    
4535 :     =head1 extract_seq
4536 :    
4537 :     usage: $seq = &FIG::extract_seq($contigs,$loc)
4538 :    
4539 :     This is just a little utility routine that I have found convenient. It assumes that
4540 :     $contigs is a hash that contains IDs as keys and sequences as values. $loc must be of the
4541 :     form
4542 :     Contig_Beg_End
4543 :    
4544 :     where Contig is the ID of one of the sequences; Beg and End give the coordinates of the sought
4545 :     subsequence. If Beg > End, it is assumed that you want the reverse complement of the subsequence.
4546 :     This routine plucks out the subsequence for you.
4547 :    
4548 :     =cut
4549 :    
4550 :     sub extract_seq {
4551 :     my($contigs,$loc) = @_;
4552 :     my($contig,$beg,$end,$contig_seq);
4553 :     my($plus,$minus);
4554 :    
4555 :     $plus = $minus = 0;
4556 :     my $strand = "";
4557 :     my @loc = split(/,/,$loc);
4558 :     my @seq = ();
4559 :     foreach $loc (@loc)
4560 :     {
4561 :     if ($loc =~ /^\S+_(\d+)_(\d+)$/)
4562 :     {
4563 :     if ($1 < $2)
4564 :     {
4565 :     $plus++;
4566 :     }
4567 :     elsif ($2 < $1)
4568 :     {
4569 :     $minus++;
4570 :     }
4571 :     }
4572 :     }
4573 :     if ($plus > $minus)
4574 :     {
4575 :     $strand = "+";
4576 :     }
4577 :     elsif ($plus < $minus)
4578 :     {
4579 :     $strand = "-";
4580 :     }
4581 :    
4582 :     foreach $loc (@loc)
4583 :     {
4584 :     if ($loc =~ /^(\S+)_(\d+)_(\d+)$/)
4585 :     {
4586 :     ($contig,$beg,$end) = ($1,$2,$3);
4587 :     if (($beg < $end) || (($beg == $end) && ($strand eq "+")))
4588 :     {
4589 :     $strand = "+";
4590 :     push(@seq,substr($contigs->{$contig},$beg-1,($end+1-$beg)));
4591 :     }
4592 :     else
4593 :     {
4594 :     $strand = "-";
4595 :     push(@seq,&reverse_comp(substr($contigs->{$contig},$end-1,($beg+1-$end))));
4596 :     }
4597 :     }
4598 :     }
4599 :     return join("",@seq);
4600 :     }
4601 :    
4602 :     =pod
4603 :    
4604 : overbeek 1.85 =head1 all_contigs
4605 :    
4606 :     usage: @contig_ids = $fig->all_contigs($genome)
4607 :    
4608 :     Returns a list of all of the contigs occurring in the designated genome.
4609 :    
4610 :     =cut
4611 :    
4612 :     sub all_contigs {
4613 :     my($self,$genome) = @_;
4614 :     my($rdbH,$relational_db_response);
4615 :    
4616 :     $rdbH = $self->db_handle;
4617 :     if (defined($genome))
4618 :     {
4619 :     if ($relational_db_response = $rdbH->SQL("SELECT DISTINCT contig FROM contig_lengths WHERE ( genome = \'$genome\' )"))
4620 :     {
4621 :     return map { $_->[0] } @$relational_db_response;
4622 :     }
4623 :     }
4624 :     return undef;
4625 :     }
4626 :    
4627 :     =pod
4628 :    
4629 : efrank 1.1 =head1 contig_ln
4630 :    
4631 :     usage: $n = $fig->contig_ln($genome,$contig)
4632 :    
4633 :     Returns the length of $contig from $genome.
4634 :    
4635 :     =cut
4636 :    
4637 :     sub contig_ln {
4638 :     my($self,$genome,$contig) = @_;
4639 :     my($rdbH,$relational_db_response);
4640 :    
4641 :     $rdbH = $self->db_handle;
4642 :     if (defined($genome) && defined($contig))
4643 :     {
4644 :     if (($relational_db_response = $rdbH->SQL("SELECT len FROM contig_lengths WHERE ( genome = \'$genome\' ) and ( contig = \'$contig\' )")) &&
4645 :    
4646 :     (@$relational_db_response == 1))
4647 :     {
4648 :     return $relational_db_response->[0]->[0];
4649 :     }
4650 :     }
4651 :     return undef;
4652 :     }
4653 :    
4654 :     =pod
4655 :    
4656 :     =head1 dna_seq
4657 :    
4658 :     usage: $seq = dna_seq($genome,@locations)
4659 :    
4660 :     Returns the concatenated subsequences described by the list of locations. Each location
4661 :     must be of the form
4662 :    
4663 :     Contig_Beg_End
4664 :    
4665 :     where Contig must be the ID of a contig for genome $genome. If Beg > End the location
4666 :     describes a stretch of the complementary strand.
4667 :    
4668 :     =cut
4669 :    
4670 :     sub dna_seq {
4671 :     my($self,$genome,@locations) = @_;
4672 :     my(@pieces,$loc,$contig,$beg,$end,$ln,$rdbH);
4673 :    
4674 : overbeek 1.86 @locations = map { split(/,/,$_) } @locations;
4675 : efrank 1.1 @pieces = ();
4676 :     foreach $loc (@locations)
4677 :     {
4678 :     if ($loc =~ /^(\S+)_(\d+)_(\d+)$/)
4679 :     {
4680 :     ($contig,$beg,$end) = ($1,$2,$3);
4681 :     $ln = $self->contig_ln($genome,$contig);
4682 :    
4683 :     if (! $ln) {
4684 :     print STDERR "$genome/$contig: could not get length\n";
4685 :     return "";
4686 :     }
4687 :    
4688 :     if (&between(1,$beg,$ln) && &between(1,$end,$ln))
4689 :     {
4690 :     if ($beg < $end)
4691 :     {
4692 :     push(@pieces, $self->get_dna($genome,$contig,$beg,$end));
4693 :     }
4694 :     else
4695 :     {
4696 :     push(@pieces, &reverse_comp($self->get_dna($genome,$contig,$end,$beg)));
4697 :     }
4698 :     }
4699 :     }
4700 :     }
4701 :     return join("",@pieces);
4702 :     }
4703 :    
4704 :     sub get_dna {
4705 :     my($self,$genome,$contig,$beg,$end) = @_;