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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3