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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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