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

Annotation of /FigKernelPackages/FigGFF.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : olson 1.1 #
2 :     # FIG GFF utilities.
3 :     #
4 :    
5 :     #
6 :     # A GFFWriter handles the generation of GFF files from SEED data structures.
7 :     #
8 :    
9 : olson 1.4 package FigGFF;
10 :    
11 :     use strict;
12 :    
13 :     use base qw(Exporter);
14 :     use vars qw(@EXPORT);
15 :     @EXPORT = qw(map_seed_alias_to_dbxref);
16 :    
17 :     #
18 :     # General GFF-related routines.
19 :     #
20 :    
21 :    
22 :     #
23 :     # Alias translation.
24 :     #
25 :     # These routines map between the SEED aliases and the standard
26 :     # dbxref names as defined here:
27 :     #
28 :     # ftp://ftp.geneontology.org/pub/go/doc/GO.xrf_abbs
29 :     #
30 :     # In particular:
31 :     #
32 :     # abbreviation: NCBI_gi
33 :     # database: NCBI databases.
34 :     # object: Identifier.
35 :     # example_id: NCBI_gi:10727410
36 :     # generic_url: http://www.ncbi.nlm.nih.gov/
37 :     # url_syntax:
38 :     # url_example: http://www.ncbi.nlm.nih.gov:80/entrez/query.fcgi?cmd=Retrieve&db=nucleotide&list_uids=10727410&dopt=GenBank
39 :     #
40 :     # abbreviation: NCBI_NP
41 :     # database: NCBI RefSeq.
42 :     # object: Protein identifier.
43 :     # example_id: NCBI_NP:123456
44 :     # generic_url: http://www.ncbi.nlm.nih.gov/
45 :     # url_syntax:
46 :     #
47 :     # abbreviation: KEGG
48 :     # database: Kyoto Encyclopedia of Genes and Genomes.
49 :     # generic_url: http://www.genome.ad.jp/kegg/
50 :    
51 :     sub map_seed_alias_to_dbxref
52 :     {
53 :     my($alias) = @_;
54 :    
55 :     $_ = $alias;
56 :     if (/^NP_(\d+.*)/)
57 :     {
58 :     return "NCBI_NP:$1";
59 :     }
60 :     elsif (/^gi\|(\d+)/)
61 :     {
62 :     return "NCBI_gi:$1";
63 :     }
64 :     elsif (/^kegg\|(\S+):(\S+)/)
65 :     {
66 :     return "KEGG:$1 $2";
67 :     }
68 :     elsif (/^uni\|(\S+)/)
69 :     {
70 :     return "UniProt:$1";
71 :     }
72 :     elsif (/^sp\|(\S+)/)
73 :     {
74 :     return "Swiss-Prot:$1";
75 :     }
76 :    
77 :     return undef;
78 :     }
79 :    
80 :     #
81 :     # And map back again.
82 :     #
83 :    
84 :     sub map_dbxref_to_seed_alias
85 :     {
86 :     my($dbxref) = @_;
87 :    
88 : redwards 1.7 # if it is not a valid xref just return it
89 :     return $dbxref unless (m/:/);
90 :    
91 : olson 1.4 my($type, $ref) = split(/:/, $dbxref, 2);
92 :    
93 :     if ($type eq "NCBI_NP")
94 :     {
95 :     return "NP_$ref";
96 :     }
97 :     elsif ($type eq "NCBI_gi")
98 :     {
99 :     return "gi|$ref";
100 :     }
101 :     elsif ($type eq "KEGG")
102 :     {
103 :     $ref =~ s/ /:/;
104 :     return "kegg|$ref";
105 :     }
106 :     elsif ($type eq "UniProt")
107 :     {
108 :     return "uni|$ref";
109 :     }
110 :     elsif ($type eq "Swiss-Prot")
111 :     {
112 :     return "sp|$ref";
113 :     }
114 :    
115 : redwards 1.7 return $dbxref; # just return itself if we don't know what it is.
116 : olson 1.4 }
117 : olson 1.1
118 :     package GFFWriter;
119 :    
120 :     use strict;
121 :     use FIG;
122 : olson 1.4 use FigGFF;
123 : olson 1.1
124 :     use Carp;
125 :     use URI::Escape;
126 :     use Data::Dumper;
127 :    
128 :     sub new
129 :     {
130 :     my($class, $fig, %options) = @_;
131 :    
132 :     my $default_options = {
133 :     escapespace => 0,
134 :     outputfasta => 1,
135 :     linelength => 60,
136 :     };
137 :    
138 :     map { $default_options->{$_} = $options{$_} } keys(%options);
139 :    
140 : redwards 1.6 # added contig_start_cache and contig_end_cache because we have something like
141 :     # sequence-region contigname 1 10000
142 :     # in general we will set contig_start_cache == 1
143 :     # and contig_end_cache == contig_length_cache
144 :    
145 : olson 1.1 my $self = {
146 :     options => $default_options,
147 :     contig_length_cache => {},
148 : redwards 1.6 contig_start_cache => {},
149 :     contig_end_cache => {},
150 : olson 1.1 fig => $fig,
151 :     };
152 :    
153 :     return bless $self, $class;
154 :     }
155 :    
156 :    
157 :     =head1 gff3_for_feature
158 :    
159 :     Returns the GFF3 information for a given feature.
160 :    
161 :     The return is a pair ($contig_data, $fasta_sequences) that can be passed
162 :     into write_gff3().
163 :    
164 :     $contig_data is a hashref mapping a contig name to a list of GFF3 file lines
165 :     for the sequences in that contig.
166 :    
167 :     =cut
168 :    
169 :     sub gff3_for_feature
170 :     {
171 : olson 1.4 my($self, $fid, $user, $user_note, $in_aliases, $in_loc) = @_;
172 : olson 1.1
173 :     #
174 :     # Options we need to figure out somehow.
175 :     #
176 :     my $options = $self->{options};
177 :    
178 :     my $escapespace = $options->{escapespace};
179 :     my $outputfasta = $options->{outputfasta};
180 : olson 1.2
181 :     my %outputtype;
182 :     map { $outputtype{$_} = 1 } @{$options->{outputtype}};
183 : olson 1.1
184 :     my $fastasequences = '';
185 :     my $contig_data;
186 :     my $linelength = $options->{linelength};
187 :    
188 : olson 1.3 my $beg = $self->{options}->{beg};
189 :     my $end = $self->{options}->{end};
190 :    
191 : olson 1.1 my $fig = $self->{fig};
192 :    
193 :     #
194 :     # Do this first to make sure that we really have a feature.
195 :     #
196 : olson 1.4 my @location = ref($in_loc) ? @$in_loc : $fig->feature_location($fid);
197 : olson 1.1 if (@location == 0 or !defined($location[0]))
198 :     {
199 :     warn "No location found for feature $fid\n";
200 :     return ({}, "");
201 :     }
202 :    
203 :     ###########
204 :     #
205 :     # Begin figuring out the column 9 information about notes and aliases and GO terms
206 :     # All the information is temporarily stored in @alias or @note, and at the end is joined
207 :     # into $allnote
208 :     #
209 :     ###########
210 :    
211 :     #
212 :     # the notes for the last column
213 :     #
214 :     my $note;
215 :     #
216 :     # all the aliases we are going to use
217 :     #
218 :     my @alias;
219 : olson 1.4 my @xref;
220 : olson 1.1
221 : olson 1.2 if ($options->{with_assignments})
222 : olson 1.1 {
223 : olson 1.2 my $func = $fig->function_of($fid, $user);
224 :     if ($func)
225 :     {
226 : olson 1.4 push @$note, ("Note=" . uri_escape($func));
227 : olson 1.2 }
228 : olson 1.1 }
229 : olson 1.2
230 :     if ($options->{with_aliases})
231 :     {
232 : olson 1.4 # now find aliases
233 :     my @feat_aliases = ref($in_aliases) ? @$in_aliases : $fig->feature_aliases($fid);
234 :     foreach my $alias (@feat_aliases)
235 : olson 1.1 {
236 : olson 1.4 my $mapped = FigGFF::map_seed_alias_to_dbxref($alias);
237 :     if ($mapped)
238 : olson 1.2 {
239 : olson 1.4 push(@xref, $mapped);
240 : olson 1.2 }
241 :     else
242 :     {
243 : olson 1.4 push(@alias, $alias);
244 : olson 1.2 }
245 : olson 1.1 }
246 : olson 1.2 }
247 : olson 1.1
248 :     # now just join all the aliases and put them into @$note so we can add it to the array
249 :     if (@alias)
250 :     {
251 : olson 1.4 push @$note, "Alias=". join (",", map { uri_escape($_) } @alias);
252 : olson 1.1 }
253 : olson 1.2
254 :     #
255 :     # If we have user note passed in, add it.
256 :     #
257 :    
258 :     if ($user_note)
259 :     {
260 :     push @$note, $user_note;
261 :     }
262 : olson 1.1
263 :     # the LAST thing I am going to add as a note is the FIG id so that I can grep it out easily
264 : olson 1.4 #
265 :     # for now, make SEED xref the first in the list so we can search for DBxref=SEEd
266 :     #
267 :    
268 :     unshift(@xref, "SEED:$fid");
269 :    
270 :     push(@$note, "Dbxref=" . join(",", map { uri_escape($_) } @xref));
271 : olson 1.1
272 :     # finally join all the notes into a long string that can be added as column 9
273 :     my $allnotes;
274 :     $allnotes = join ";", @$note;
275 :    
276 :     # do we want to convert '%20' to ' '
277 :     unless ($escapespace)
278 :     {
279 :     $allnotes =~ s/\%20/ /g;
280 :     }
281 :    
282 :     ###########
283 :     #
284 :     # End figuring out the column 9 information about notes and aliases and GO terms
285 :     #
286 :     ###########
287 :    
288 :     #
289 :     # Cache contig lengths.
290 :     #
291 :     my $len = $self->{contig_length_cache};
292 :    
293 :     my $genome = $fig->genome_of($fid);
294 :    
295 :     foreach my $loc (@location)
296 :     {
297 :     $loc =~ /^(.*)\_(\d+)\_(\d+)$/;
298 :     my ($contig, $start, $stop) = ($1, $2, $3);
299 :     my $original_contig=$contig;
300 :    
301 :     #
302 :     # the contig name must be escaped
303 :     #
304 :     $contig = uri_escape($contig);
305 :    
306 :     #my $contig_key = "$genome:$contig";
307 :     my $contig_key = $contig;
308 :    
309 :     unless (defined $len->{$contig})
310 :     {
311 :     $len->{$contig}=$fig->contig_ln($genome, $original_contig);
312 :     }
313 :     my $strand='+';
314 :    
315 :     #
316 :     # These were bounds-checking for dumping all of a genome.
317 :     #
318 :     #next if (defined $beg && ($start < $beg || $stop < $beg));
319 :     #next if (defined $end && ($start > $end || $stop > $end));
320 :    
321 :     if ($start > $stop)
322 :     {
323 :     ($start, $stop, $strand)=($stop, $start, '-');
324 :     }
325 :     elsif ($start == $stop)
326 :     {
327 :     $strand=".";
328 :     }
329 :    
330 :     my $type=$fig->ftype($fid);
331 :    
332 :     if ($type eq "peg")
333 :     {
334 :     # it is a protein coding gene
335 :     # create an artificial id that is just the fid.(\d+) information
336 :     # we will use this to create ids in the form cds.xxx; trn.xxxx; pro.xxx; gen.xxx;
337 :     $fid =~ /\.peg\.(\d+)/;
338 :     my $geneid=$1;
339 :    
340 :     ############## KLUDGE
341 :     #
342 :     # At the moment the outputs for transcript, gene, CDS, and pro are all the same.
343 :     # This is clearly a kludge and wrong, but it will work at the moment
344 :     #
345 :    
346 :     # defined some truncations
347 :     my %trunc=(
348 :     "transcript" => "trn",
349 :     "gene" => "gen",
350 :     "protein" => "pro",
351 :     "cds" => "cds",
352 :     );
353 :    
354 :     # SO terms:
355 :     # transcript: SO:0000673
356 :     # gene: SO:0000704
357 :     # cds: SO:0000316
358 :     # protein: NOT VALID: should be protein_coding_primary_transcript SO:0000120
359 : olson 1.3
360 :     #
361 :     # For now, we will only output CDS features, and include
362 :     # the translation as an attribute (attribuute name is
363 :     # translation_id, value is a key that corresponds to a FASTA
364 :     # section at the end of the file).
365 :     #
366 :    
367 :     my $type = "cds";
368 :    
369 :     my $protein_id = "pro.$geneid";
370 :     my $cds_id = "cds.$geneid";
371 :    
372 :     # we want to store some sequences to be output
373 :     if ($outputfasta)
374 : olson 1.1 {
375 : olson 1.3 my $addseq = $fig->get_translation($fid);
376 :    
377 :     #
378 :     # the chomp is so that we know for sure to add the line back
379 :     #
380 :     $addseq =~ s/(.{$linelength})/$1\n/g;
381 :     chomp($addseq);
382 :     $fastasequences .= ">$protein_id\n$addseq\n";
383 :    
384 : olson 1.4 my $addseq = uc($fig->dna_seq($genome, @location));
385 : olson 1.3 $addseq =~ s/(.{$linelength})/$1\n/g; chomp($addseq);
386 :    
387 :     $fastasequences .= ">$cds_id\n$addseq\n";
388 :    
389 :     $allnotes .= ";translation_id=$protein_id";
390 :     }
391 :    
392 :     push (@{$contig_data->{$contig_key}},
393 :     (join "\t",
394 :     ($contig, "The SEED", $type, $start, $stop, ".", $strand, ".", "ID=$cds_id;$allnotes")));
395 :     }
396 : olson 1.1 elsif ($type eq "rna")
397 :     {
398 :     $fid =~ /\.rna\.(\d+)/;
399 :     my $geneid=$1;
400 :     #
401 :     # tRNA is a valid SOFA term == SO:0000253
402 :     #
403 :     my ($id, $type)=("rna.$geneid", "tRNA");
404 :     if ($outputfasta)
405 :     {
406 : olson 1.4 my $addseq = $fig->dna_seq($genome, @location);
407 : olson 1.1 $addseq =~ s/(.{$linelength})/$1\n/g; chomp($addseq);
408 :     $fastasequences .= ">$id\n$addseq\n";
409 :     }
410 : olson 1.2 push (@{$contig_data->{$contig_key}}, (join "\t", ($contig, "The SEED", $type, $start, $stop, ".", $strand, ".", "ID=$id;$allnotes")));
411 : olson 1.1 } # end the if type == rna
412 :     else
413 :     {
414 :     die "Don't know what type: |$type| is";
415 :     }
416 :     }
417 :     return ($contig_data, $fastasequences);
418 :     }
419 :    
420 :     =head1 write_gff3
421 :    
422 :     Write a set of gff3 per-contig data and fasta sequence data to a file or filehandle.
423 :    
424 :     $genome is the genome these contigs are a part of.
425 :     $contig_list is a list of contig-data hashes as returned by gff_for_feature.
426 :     $fast_list is a list of fasta data strings.
427 :    
428 :     =cut
429 :    
430 :     sub write_gff3
431 :     {
432 :     my($self, $output, $genome, $contig_list, $fasta_list) = @_;
433 :    
434 :     my $fig = $self->{fig};
435 :    
436 :     my $len = $self->{contig_length_cache};
437 :     my $fh;
438 :    
439 :     my $beg = $self->{options}->{beg};
440 :     my $end = $self->{options}->{end};
441 :    
442 :     my $close_output;
443 :    
444 :     if (ref($output))
445 :     {
446 :     $fh = $output;
447 :     }
448 :     else
449 :     {
450 :     open($fh, ">$output") or confess "Cannot open output '$output': $!";
451 :     $close_output = 1;
452 :     }
453 :    
454 :     #
455 :     # Build a data structure from the list of contigs
456 :     # that has a list of lists of data per contig name.
457 :     # (Do this so we don't copy all of the contig data itself, as it
458 :     # could be quite large).
459 :     #
460 :     my %contigs;
461 :    
462 :     #
463 :     # iterate over the given list of contig hashes.
464 :     #
465 :     for my $chash (@$contig_list)
466 :     {
467 :     #
468 :     # Then for each contig in the individual contig hashes,
469 :     # add the data list to %contigs.
470 :     #
471 :     for my $contig (keys %$chash)
472 :     {
473 :     push(@{$contigs{$contig}}, $chash->{$contig});
474 :     }
475 :     }
476 :    
477 :     foreach my $contig (sort keys %contigs)
478 :     {
479 :     print $fh "##sequence-region\t$contig\t";
480 :     if (defined $beg) {
481 :     print $fh "$beg\t";
482 :     } else {
483 :     print $fh "1\t";
484 :     }
485 :     if (defined $end) {
486 :     print $fh "$end\n";
487 :     } else {
488 :     print $fh "$len->{$contig}\n";
489 :     }
490 :     for my $list (@{$contigs{$contig}})
491 :     {
492 : olson 1.2 print $fh join("\n", @$list), "\n";
493 : olson 1.1 }
494 :     }
495 :    
496 :     print $fh "##FASTA\n";
497 :     # print out the cds and pro if we need them
498 :    
499 :     if ($self->{options}->{outputfasta})
500 :     {
501 :     for my $fastasequences (@$fasta_list)
502 :     {
503 :     print $fh $fastasequences;
504 :     }
505 :     }
506 :    
507 :     my $ll = $self->{options}->{linelength};
508 :     foreach my $contig (sort keys %contigs)
509 :     {
510 :     my $len=$fig->contig_ln($genome, $contig);
511 :     my $dna_seq=$fig->dna_seq($genome, $contig . "_1_". $len);
512 :     if (defined $beg)
513 :     {
514 :     unless (defined $end) {
515 :     $end=$len;
516 :     }
517 :     $dna_seq = substr($dna_seq, $beg, $end);
518 :     }
519 :     elsif (defined $end)
520 :     {
521 :     $beg=1;
522 :     $dna_seq = substr($dna_seq, $beg, $end);
523 :     }
524 :    
525 :     my $contig=uri_escape($contig);
526 :    
527 :     $dna_seq =~ s/(.{$ll})/$1\n/g;
528 :     chomp($dna_seq); # just remove the last \n if there is one
529 :     print $fh ">$contig\n$dna_seq\n";
530 :     }
531 :    
532 :     close($fh) if $close_output;
533 :     }
534 :    
535 : olson 1.2 package GFFParser;
536 :    
537 :     use strict;
538 :     use URI::Escape;
539 :     use Carp;
540 :     use Data::Dumper;
541 :    
542 :     use base qw(Class::Accessor);
543 :    
544 :     __PACKAGE__->mk_accessors(qw(fig current_file));
545 :    
546 :     my $count;
547 :    
548 :    
549 :     #
550 :     # GFF file parser. Creates GFFFiles.
551 :     #
552 :    
553 :     sub new
554 :     {
555 :     my($class, $fig) = @_;
556 :    
557 :     my $self = {
558 :     fig => $fig,
559 :     };
560 :    
561 :     return bless($self, $class);
562 :     }
563 :    
564 :     sub parse
565 :     {
566 :     my($self, $file) = @_;
567 :    
568 :     my($fh, $close_handle);
569 :    
570 :     my $fobj = GFFFile->new($self->fig);
571 :     $self->current_file($fobj);
572 :    
573 :     if (ref($file) ? (ref($file) eq 'GLOB'
574 :     || UNIVERSAL::isa($file, 'GLOB')
575 :     || UNIVERSAL::isa($file, 'IO::Handle'))
576 :     : (ref(\$file) eq 'GLOB'))
577 :     {
578 :     $fh = $file;
579 :     }
580 :     else
581 :     {
582 :     open($fh, "<$file") or confess "Cannot open $file: $!";
583 :     $fobj->filename($file);
584 :     $close_handle = 1;
585 :     }
586 :    
587 :     #
588 :     # Start parsing by verifying this is a gff3 file.
589 :     #
590 :    
591 :     $_ = <$fh>;
592 :    
593 :     if (m,^\#gff-version\t(\S+),)
594 :     {
595 :     if ($1 != 3)
596 :     {
597 :     confess "Invalid GFF File: version is not 3";
598 :     }
599 :     }
600 :    
601 :     #
602 :     # Now parse.
603 :     #
604 :    
605 :     while (<$fh>)
606 :     {
607 :     chomp;
608 : overbeek 1.13 next unless ($_); # ignore empty lines
609 : olson 1.2 #
610 :     # Check first for the fasta directive so we can run off and parse that
611 :     # separately.
612 :     #
613 :    
614 :     if (/^>/)
615 :     {
616 :     $self->parse_fasta($fh, $_);
617 :     last;
618 :     }
619 :     elsif (/^\#\#FASTA/)
620 :     {
621 : olson 1.10 # print "Got fasta directive\n";
622 : olson 1.2 $_ = <$fh>;
623 :     chomp;
624 :     $self->parse_fasta($fh, $_);
625 :     last;
626 :     }
627 :     elsif (/^\#\s/)
628 :     {
629 :     #
630 :     # comment.
631 :     #
632 :     next;
633 :     }
634 :     elsif (/^\#\#(\S+)(?:\t(.*))?/)
635 :     {
636 :     #
637 :     # GFF3 directive.
638 :     #
639 :    
640 :     $self->parse_gff3_directive($1, $2);
641 :    
642 :     }
643 :     elsif (/^\#(\S+)(?:\t(.*))?/)
644 :     {
645 :     #
646 :     # Directive.
647 :     #
648 :    
649 : redwards 1.5 if (lc($1) eq "seed")
650 : olson 1.2 {
651 :     $self->parse_seed_directive($2);
652 :     }
653 :     else
654 :     {
655 :     $self->parse_local_directive($1, $2);
656 :     }
657 :    
658 :     }
659 :     elsif (/^([^\t]+)\t([^\t]+)\t([^\t]+)\t([^\t]+)\t([^\t]+)\t([^\t]+)\t([^\t]+)\t([^\t]+)\t([^\t]+)$/)
660 :     {
661 :     $self->parse_feature($1, $2, $3, $4, $5, $6, $7, $8, $9);
662 :     }
663 :     else
664 :     {
665 :     die "bad line: '$_'\n";
666 :     }
667 :     }
668 :    
669 :     return $fobj;
670 :     }
671 :    
672 :     sub parse_gff3_directive
673 :     {
674 :     my($self, $directive, $rest) = @_;
675 :    
676 : redwards 1.6 $directive = lc($directive);
677 : redwards 1.11 # this should catch both #seed and ##seed :-)
678 :     if ($directive eq "seed")
679 : redwards 1.6 {
680 : redwards 1.11 return $self->parse_seed_directive($rest);
681 : redwards 1.6 }
682 : redwards 1.11
683 :     my @rest=split /\t/, $rest;
684 :    
685 :     # removed genome, genome_md5, origin, taxnomy as they are not real gff directives. These are in seed_directives below
686 :     if ($directive eq "project")
687 : redwards 1.6 {
688 : redwards 1.11 # I am not sure if PROJECT is a seed directive or a GFF directive
689 : redwards 1.6 $self->current_file->project($rest[0]);
690 :     }
691 :     elsif ($directive eq "sequence-region")
692 :     {
693 : redwards 1.7 $self->current_file->contigs($rest[0]);
694 : redwards 1.6 $self->{contig_length_cache}->{$rest[0]}=$rest[2]-$rest[1];
695 :     $self->{contig_start_cache}->{$rest[0]}=$rest[1];
696 :     $self->{contig_end_cache}->{$rest[0]}=$rest[2];
697 :     }
698 :     else
699 :     {
700 : olson 1.10 print STDERR "Have gff3 directive '$directive' rest='$rest'\n";
701 : redwards 1.6 }
702 :    
703 : olson 1.2 }
704 :    
705 :     sub parse_seed_directive
706 :     {
707 :     my($self, $rest) = @_;
708 :    
709 :     my($verb, @rest) = split(/\t/, $rest);
710 :    
711 : redwards 1.6 # are we case sensitive? I don't think so
712 : redwards 1.11 $verb=lc($verb);
713 :    
714 : olson 1.12 if ($verb eq "genome_id")
715 : redwards 1.11 {
716 :     $self->current_file->genome_id($rest[0]);
717 : olson 1.12 }
718 :     elsif ($verb eq "name")
719 :     {
720 :     $self->current_file->genome_name($rest[0]);
721 : redwards 1.11 }
722 :     elsif ($verb eq "genome_md5")
723 :     {
724 : olson 1.12 $self->current_file->set_genome_checksum($rest[0]);
725 : redwards 1.11 }
726 :     elsif ($verb eq "project")
727 :     {
728 :     # I am not sure if PROJECT is a seed directive or a GFF directive
729 :     $self->current_file->project($rest[0]);
730 :     }
731 :     elsif ($verb eq "taxonomy")
732 :     {
733 : olson 1.12 $self->current_file->taxonomy($rest[0]);
734 :     }
735 :     elsif ($verb eq "taxon_id")
736 :     {
737 :     $self->current_file->taxon_id($rest[0]);
738 : redwards 1.11 }
739 :     elsif ($verb eq "anno_start")
740 : olson 1.2 {
741 :     $self->current_file->anno_start($rest[0]);
742 :     }
743 :     elsif ($verb eq "anno_end")
744 :     {
745 :     $self->current_file->anno_start($rest[0]);
746 :     }
747 :     elsif ($verb eq "contig_md5")
748 :     {
749 :     $self->current_file->set_contig_checksum(@rest[0,1,2]);
750 :     }
751 :     }
752 :    
753 :     sub parse_local_directive
754 :     {
755 :     my($self, $directive, $rest) = @_;
756 :    
757 : olson 1.10 print STDERR "Have local directive '$directive' rest='$rest'\n";
758 : olson 1.2 }
759 :    
760 :     sub parse_feature
761 :     {
762 :     my($self, $seqid, $source, $type, $start, $end, $score, $strand, $phase, $attributes) = @_;
763 :    
764 :     #print "data: seqid=$seqid source=$source type=$type start=$start end=$end\n";
765 :     #print " score=$score strand=$strand phase=$phase\n";
766 :     #print " $attributes\n";
767 :    
768 :     #
769 :     # Parse this feature, creating a GFFFeature object for it.
770 :     #
771 :    
772 :     my $feature = GFFFeature->new($self->fig);
773 :    
774 :     $feature->seqid($seqid);
775 :     $feature->source($source);
776 :     $feature->type($type);
777 :     $feature->start($start);
778 :     $feature->end($end);
779 :     $feature->score($score);
780 :     $feature->strand($strand);
781 :     $feature->phase($phase);
782 :    
783 :     my $athash = {};
784 :    
785 :     for my $attr (split(/;/, $attributes))
786 :     {
787 :     my($name, $value) = split(/=/, $attr);
788 :    
789 : olson 1.4 my @values = map { uri_unescape($_) } split(/,/, $value);
790 :    
791 : redwards 1.7 # handle the aliases
792 :     if ($name eq "Alias") {
793 :     foreach my $val (@values)
794 :     {
795 :     $val = FigGFF::map_dbxref_to_seed_alias($val);
796 :     }
797 :     }
798 :    
799 : olson 1.2 #
800 : olson 1.4 # This might be a little goofy for the users, but we will use it
801 :     # for now:
802 :     #
803 :     # if there is more than one value, the value is a ref to a list
804 :     # of the values.
805 :     #
806 :     # Otherwise, the value is a scalar.
807 : olson 1.2 #
808 :    
809 :     if (@values > 1)
810 :     {
811 : olson 1.4 #
812 :     # Yes, you can do this ... I had to look it up :-).
813 :     #
814 :     # It's in 'man perlfaq3'.
815 :     #
816 :    
817 :     $value = \@values;
818 : olson 1.2 }
819 :    
820 :     $athash->{$name} = $value;
821 :    
822 : olson 1.4 #
823 :     # Handle the GFF3-defined attributes.
824 :     #
825 :     # These show up as Class::Accessor's on the feature object.
826 :     #
827 :    
828 : olson 1.2 if ($GFFFeature::GFF_Tags{$name})
829 :     {
830 :     $feature->set($name, $value);
831 : olson 1.4
832 :     if ($name eq "Dbxref")
833 :     {
834 :     #
835 :     # If we have a SEED:figid DBxref, set the genome and fig_id attributes.
836 :     #
837 :    
838 :     my @seed_xref = grep /^"?SEED:/, @values;
839 :     if (@seed_xref and $seed_xref[0] =~ /^"?SEED:(fig\|(\d+\.\d+)\..*)/)
840 :     {
841 :     $feature->genome($2);
842 :     $feature->fig_id($1);
843 :     }
844 :    
845 :     }
846 : olson 1.2 }
847 :     }
848 :     $feature->attributes($athash);
849 :    
850 : olson 1.4
851 : olson 1.2 $self->current_file->add_feature($feature);
852 :     }
853 :    
854 :     #
855 :     # We come in here with the first line of the fasta already read
856 :     # in order to support the backward-compatiblity syntax that
857 :     # lets a file skip the ##FASTA directive if it wishes.
858 :     #
859 :     sub parse_fasta
860 :     {
861 :     my($self, $fh, $first_line) = @_;
862 :     my($cur, $cur_id);
863 :    
864 :     for ($_ = $first_line; $_; $_ = <$fh>, chomp)
865 :     {
866 :     if (/^>\s*(\S+)/)
867 :     {
868 :     if ($cur)
869 :     {
870 :     $self->handle_fasta_block($cur_id, $cur);
871 :     }
872 :    
873 :     $cur = '';
874 :     $cur_id = $1;
875 :     }
876 :     else
877 :     {
878 :     s/^\s*$//;
879 :     s/\s*$//;
880 :     if (/\s/)
881 :     {
882 :     die "FASTA data had embedded space: $_\n";
883 :     }
884 :     $cur .= $_;
885 :     }
886 :     }
887 :     if ($cur)
888 :     {
889 :     $self->handle_fasta_block($cur_id, $cur);
890 :     }
891 :     }
892 :    
893 :     sub handle_fasta_block
894 :     {
895 :     my($self, $id, $data) = @_;
896 :    
897 :     my $len = length($data);
898 : redwards 1.7 $self->current_file->fasta_data($id, $data);
899 : olson 1.2 }
900 :    
901 :     package GFFFeature;
902 :    
903 :     use strict;
904 :     use base qw(Class::Accessor);
905 :    
906 :     our @GFF_Tags = qw(ID Name Alias Parent Target Gap Note Dbxref Ontology_term);
907 :     our %GFF_Tags;
908 :    
909 :     map { $GFF_Tags{$_} = 1 } @GFF_Tags;
910 :    
911 : olson 1.12 __PACKAGE__->mk_accessors(qw(fig seqid source type start end score strand phase attributes
912 :     genome fig_id),
913 : olson 1.2 @GFF_Tags);
914 :    
915 :    
916 :     sub new
917 :     {
918 :     my($class, $fig) = @_;
919 :    
920 :     my $self = {
921 :     fig => $fig,
922 :     };
923 :    
924 :     return bless($self, $class);
925 :     }
926 :    
927 : olson 1.4 sub find_local_feature
928 :     {
929 :     my($self, $local_genome) = @_;
930 :     my $db = $self->fig->db_handle;
931 :    
932 :     # For debugging.
933 :     undef $local_genome;
934 :     if ($local_genome)
935 :     {
936 :     #
937 :     # It's a precise match. We need to determine if we have this
938 :     # particular feature in this SEED (it is possible for one to
939 :     # have exported an annotation for a feature that was added
940 :     # to a genome after its initial release).
941 :     #
942 :     # We do this by searching for a local feature with the same contig,
943 :     # start, and stop as this feature.
944 :     #
945 :    
946 :     my $qry = qq(SELECT id
947 :     FROM features
948 :     WHERE (genome = ? AND
949 :     contig = ? AND
950 :     minloc = ? AND
951 :     maxloc = ?));
952 :     my $res = $db->SQL($qry, undef, $local_genome, $self->seqid,
953 :     $self->start, $self->end);
954 :    
955 :     return map { $_->[0] } @$res;
956 :     }
957 :    
958 :     #
959 :     # Otherwise, we need to try a set of heuristics to match
960 :     # this id.
961 :     #
962 :    
963 :     #
964 :     # Try matching aliases first.
965 :     #
966 :    
967 :     my @aliases = grep { !/^\"?SEED/ } ref($self->Dbxref) ? @{$self->Dbxref} : ($self->Dbxref);
968 :    
969 :     my @maliases = map { FigGFF::map_dbxref_to_seed_alias($_) } @aliases;
970 :    
971 :     print "Found aliases @aliases\n";
972 :     print "Found mapped aliases @maliases\n";
973 :    
974 :     for my $malias (@maliases)
975 :     {
976 :     my $fid = $self->fig->by_alias($malias);
977 :     if ($fid)
978 :     {
979 :     print "Mapped $malias to $fid\n";
980 :     }
981 :     }
982 :    
983 :     }
984 :    
985 :    
986 : olson 1.2 package GFFFile;
987 :    
988 :     use strict;
989 :     use base qw(Class::Accessor);
990 :    
991 : olson 1.12 __PACKAGE__->mk_accessors(qw(fig filename features feature_index anno_start anno_end taxon_id genome_id));
992 : olson 1.2
993 :     #
994 :     # Package to hold the contents of a GFF file, and to hold the code
995 :     # for mapping its contents to the local SEED.
996 :     #
997 :     # Created by GFFParser->parse.
998 :     #
999 :    
1000 :     sub new
1001 :     {
1002 :     my($class, $fig) = @_;
1003 :    
1004 :     my $self = {
1005 :     fig => $fig,
1006 :     features => [],
1007 : redwards 1.6 contigs => [],
1008 : olson 1.2 feature_index => {},
1009 : olson 1.12 genome_checksum => '',
1010 : olson 1.4 contig_checksum => {},
1011 :     features_by_genome => {},
1012 : olson 1.2 };
1013 :     return bless($self, $class);
1014 :     }
1015 :    
1016 :     sub add_feature
1017 :     {
1018 :     my($self, $feature) = @_;
1019 :    
1020 :     push(@{$self->features}, $feature);
1021 :     $self->feature_index->{$feature->ID} = $feature;
1022 : olson 1.4 push(@{$self->{features_by_genome}->{$feature->genome}}, $feature);
1023 :     }
1024 :    
1025 :     sub features_for_genome
1026 :     {
1027 :     my($self, $genome) = @_;
1028 :    
1029 :     return $self->{features_by_genome}->{$genome};
1030 :     }
1031 :    
1032 :     sub genome_checksum
1033 :     {
1034 :     my($self) = @_;
1035 :    
1036 : olson 1.12 return $self->{genome_checksum};
1037 : olson 1.2 }
1038 :    
1039 :     sub set_genome_checksum
1040 :     {
1041 : olson 1.12 my($self, $md5sum) = @_;
1042 :     $self->{genome_checksum} = $md5sum;
1043 : olson 1.2 }
1044 :    
1045 :     sub set_contig_checksum
1046 :     {
1047 :     my($self, $genome, $contig, $md5sum) = @_;
1048 :     $self->{contig_checksum}->{$genome}->{$contig} = $md5sum;
1049 :     }
1050 :    
1051 : redwards 1.7 =head2 fasta_data()
1052 :    
1053 :     Get or set the fasta data. Given an id and some data will set the data for that id. Given an id will return the data for that id. Called without arguments will return a reference to a hash of sequences.
1054 : redwards 1.6
1055 : redwards 1.7 This means that if you give it an id and sequence it will return that sequence. Hmmm.
1056 :    
1057 :     =cut
1058 :    
1059 :     sub fasta_data
1060 : olson 1.2 {
1061 :     my($self, $id, $data) = @_;
1062 : redwards 1.7 $id && $data && ($self->{fasta_data}->{$id} = $data);
1063 :     $id && return $self->{fasta_data}->{$id};
1064 :     return $self->{fasta_data};
1065 : olson 1.2 }
1066 :    
1067 :    
1068 : redwards 1.6 =head2 contigs()
1069 :    
1070 :     Add a contig to the list, or return a reference to an array of contigs
1071 :    
1072 :     =cut
1073 :    
1074 :     sub contigs
1075 :     {
1076 :     my($self, $contig) = @_;
1077 : redwards 1.9 if ($contig && $contig =~ /\w\w\_\d+\.\d+/) {
1078 :     print STDERR "WARNING: $contig appears to have a version number. We should standardize on timming that somewhere\n";
1079 :     }
1080 : redwards 1.6 $contig && (push @{$self->{contigs}}, $contig);
1081 :     return $self->{contigs};
1082 :     }
1083 :    
1084 :     =head2 contig_length()
1085 :    
1086 :     Get or set the length of a specfic contig.
1087 :     my $length=$fob->contig_length($contig, $length);
1088 :     my $length=$fob->contig_length($contig);
1089 :    
1090 :     =cut
1091 :    
1092 :     sub contig_length
1093 :     {
1094 :     my($self, $contig, $length) = @_;
1095 :     $length && ($self->{contig_length_cache}->{$contig}=$length);
1096 :     return $self->{contig_length_cache}->{$contig};
1097 :     }
1098 :    
1099 :     =head1 Information about the source of the sequence.
1100 :    
1101 :     These are things that we have parsed out the GFF3 file, or want to add into the GFF3 file. We can use these methods to get or set them as required. In general, if a value is supplied that will be used as the new value.
1102 :    
1103 :     =cut
1104 :    
1105 :     =head2 genome_id()
1106 :    
1107 :     Get or set a genome id for this file.
1108 :    
1109 :     =cut
1110 :    
1111 :     sub genome_id
1112 :     {
1113 :     my($self, $genomeid) = @_;
1114 :     $genomeid && ($self->{genome_id}=$genomeid);
1115 :     return $self->{genome_id};
1116 :     }
1117 :    
1118 :     =head2 genome_name()
1119 :    
1120 :     Get or set a genome id for this file.
1121 :    
1122 :     =cut
1123 :    
1124 :     sub genome_name
1125 :     {
1126 :     my($self, $genomename) = @_;
1127 :     $genomename && ($self->{genome_name}=$genomename);
1128 :     return $self->{genome_name};
1129 :     }
1130 :    
1131 :     =head2 project()
1132 :    
1133 :     Get or set the project.
1134 :    
1135 :     =cut
1136 :    
1137 :     sub project
1138 :     {
1139 :     my ($self, $pro) = @_;
1140 :     $pro && ($self->{project}=$pro);
1141 :     return $self->{project};
1142 :     }
1143 :    
1144 :     =head2 taxonomy()
1145 :    
1146 :     Get or set the taxonomy
1147 :    
1148 :     =cut
1149 :    
1150 :     sub taxonomy
1151 :     {
1152 :     my($self, $tax) = @_;
1153 :     $tax && ($self->{taxonomy}=$tax);
1154 :     return $self->{taxonomy};
1155 :     }
1156 :    
1157 :    
1158 :    
1159 :    
1160 :    
1161 : olson 1.1 1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3