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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3