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

Annotation of /FigKernelPackages/FIG.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.34 - (view) (download) (as text)

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3