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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3