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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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