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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3