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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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