-
Notifications
You must be signed in to change notification settings - Fork 178
/
embl.pm
1621 lines (1330 loc) · 49.4 KB
/
embl.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#
# BioPerl module for Bio::SeqIO::EMBL
#
# Please direct questions and support issues to <bioperl-l@bioperl.org>
#
# Cared for by Ewan Birney <birney@ebi.ac.uk>
#
# Copyright Ewan Birney
#
# You may distribute this module under the same terms as perl itself
# POD documentation - main docs before the code
=head1 NAME
Bio::SeqIO::embl - EMBL sequence input/output stream
=head1 SYNOPSIS
It is probably best not to use this object directly, but
rather go through the SeqIO handler system. Go:
$stream = Bio::SeqIO->new(-file => $filename, -format => 'EMBL');
while ( (my $seq = $stream->next_seq()) ) {
# do something with $seq
}
=head1 DESCRIPTION
This object can transform Bio::Seq objects to and from EMBL flat
file databases.
There is a lot of flexibility here about how to dump things which
should be documented more fully.
There should be a common object that this and Genbank share (probably
with Swissprot). Too much of the magic is identical.
=head2 Optional functions
=over 3
=item _show_dna()
(output only) shows the dna or not
=item _post_sort()
(output only) provides a sorting func which is applied to the FTHelpers
before printing
=item _id_generation_func()
This is function which is called as
print "ID ", $func($annseq), "\n";
To generate the ID line. If it is not there, it generates a sensible ID
line using a number of tools.
If you want to output annotations in EMBL format they need to be
stored in a Bio::Annotation::Collection object which is accessible
through the Bio::SeqI interface method L<annotation()|annotation>.
The following are the names of the keys which are polled from a
L<Bio::Annotation::Collection> object.
reference - Should contain Bio::Annotation::Reference objects
comment - Should contain Bio::Annotation::Comment objects
dblink - Should contain Bio::Annotation::DBLink objects
=back
=head1 FEEDBACK
=head2 Mailing Lists
User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to one
of the Bioperl mailing lists. Your participation is much appreciated.
bioperl-l@bioperl.org - General discussion
http://bioperl.org/wiki/Mailing_lists - About the mailing lists
=head2 Support
Please direct usage questions or support issues to the mailing list:
I<bioperl-l@bioperl.org>
rather than to the module maintainer directly. Many experienced and
reponsive experts will be able look at the problem and quickly
address it. Please include a thorough description of the problem
with code and data examples if at all possible.
=head2 Reporting Bugs
Report bugs to the Bioperl bug tracking system to help us keep track
the bugs and their resolution. Bug reports can be submitted via
the web:
https://github.com/bioperl/bioperl-live/issues
=head1 AUTHOR - Ewan Birney
Email birney@ebi.ac.uk
=head1 APPENDIX
The rest of the documentation details each of the object
methods. Internal methods are usually preceded with a _
=cut
# Let the code begin...
package Bio::SeqIO::embl;
use vars qw(%FTQUAL_NO_QUOTE);
use strict;
use Bio::SeqIO::FTHelper;
use Bio::SeqFeature::Generic;
use Bio::Species;
use Bio::Seq::SeqFactory;
use Bio::Annotation::Collection;
use Bio::Annotation::Comment;
use Bio::Annotation::Reference;
use Bio::Annotation::DBLink;
use base qw(Bio::SeqIO);
# Note that a qualifier that exceeds one line (i.e. a long label) will
# automatically be quoted regardless:
%FTQUAL_NO_QUOTE=(
'anticodon'=>1,
'citation'=>1,
'codon'=>1,
'codon_start'=>1,
'cons_splice'=>1,
'direction'=>1,
'evidence'=>1,
'label'=>1,
'mod_base'=> 1,
'number'=> 1,
'rpt_type'=> 1,
'rpt_unit'=> 1,
'transl_except'=> 1,
'transl_table'=> 1,
'usedin'=> 1,
);
sub _initialize {
my($self,@args) = @_;
$self->SUPER::_initialize(@args);
# hash for functions for decoding keys.
$self->{'_func_ftunit_hash'} = {};
# sets this to one by default. People can change it
$self->_show_dna(1);
if ( ! defined $self->sequence_factory ) {
$self->sequence_factory(Bio::Seq::SeqFactory->new
(-verbose => $self->verbose(),
-type => 'Bio::Seq::RichSeq'));
}
}
=head2 next_seq
Title : next_seq
Usage : $seq = $stream->next_seq()
Function: returns the next sequence in the stream
Returns : Bio::Seq object
Args :
=cut
sub next_seq {
my ($self,@args) = @_;
my ($pseq,$c,$line,$name,$desc,$acc,$seqc,$mol,$div,
$date, $comment, @date_arr);
my ($annotation, %params, @features) =
Bio::Annotation::Collection->new();
$line = $self->_readline;
# This needs to be before the first eof() test
if ( !defined $line ) {
return; # no throws - end of file
}
if ( $line =~ /^\s+$/ ) {
while ( defined ($line = $self->_readline) ) {
$line =~/^\S/ && last;
}
# return without error if the whole next sequence was just a single
# blank line and then eof
return unless $line;
}
# no ID as 1st non-blank line, need short circuit and exit routine
$self->throw("EMBL stream with no ID. Not embl in my book")
unless $line =~ /^ID\s+\S+/;
# At this point we are sure that $line contains an ID header line
my $alphabet;
if ( $line =~ tr/;/;/ == 6) { # New style headers contain exactly six semicolons.
# New style header (EMBL Release >= 87, after June 2006)
my $topology;
my $sv;
# ID DQ299383; SV 1; linear; mRNA; STD; MAM; 431 BP.
# This regexp comes from the new2old.pl conversion script, from EBI
if ($line =~ m/^ID (\S+);\s+SV (\d+); (\w+); ([^;]+); (\w{3}); (\w{3}); (\d+) BP./) {
($name, $sv, $topology, $mol, $div) = ($1, $2, $3, $4, $6);
}
if (defined $sv) {
$params{'-seq_version'} = $sv;
$params{'-version'} = $sv;
}
if (defined $topology && $topology eq 'circular') {
$params{'-is_circular'} = 1;
}
if (defined $mol ) {
if ($mol =~ /DNA/) {
$alphabet = 'dna';
} elsif ($mol =~ /RNA/) {
$alphabet = 'rna';
} elsif ($mol =~ /AA/) {
$alphabet = 'protein';
}
}
} else {
# Old style header (EMBL Release < 87, before June 2006)
if ($line =~ /^ID\s+(\S+)[^;]*;\s+(\S+)[^;]*;\s+(\S+)[^;]*;/) {
($name, $mol, $div) = ($1, $2, $3);
}
if ($mol) {
if ( $mol =~ /circular/ ) {
$params{'-is_circular'} = 1;
$mol =~ s|circular ||;
}
if (defined $mol ) {
if ($mol =~ /DNA/) {
$alphabet='dna';
} elsif ($mol =~ /RNA/) {
$alphabet='rna';
} elsif ($mol =~ /AA/) {
$alphabet='protein';
}
}
}
}
unless( defined $name && length($name) ) {
$name = "unknown_id";
}
# $self->warn("not parsing upper annotation in EMBL file yet!");
my $buffer = $line;
local $_;
BEFORE_FEATURE_TABLE :
my $ncbi_taxid;
until ( !defined $buffer ) {
$_ = $buffer;
# Exit at start of Feature table
if ( /^(F[HT]|SQ)/ ) {
$self->_pushback($_) if( $1 eq 'SQ' || $1 eq 'FT');
last;
}
# Description line(s)
if (/^DE\s+(\S.*\S)/) {
$desc .= $desc ? " $1" : $1;
}
#accession number
if ( /^AC\s+(.*)?/ || /^PA\s+(.*)?/) {
my @accs = split(/[; ]+/, $1); # allow space in addition
$params{'-accession_number'} = shift @accs
unless defined $params{'-accession_number'};
push @{$params{'-secondary_accessions'}}, @accs;
}
#version number
if ( /^SV\s+\S+\.(\d+);?/ ) {
my $sv = $1;
#$sv =~ s/\;//;
$params{'-seq_version'} = $sv;
$params{'-version'} = $sv;
}
#date (NOTE: takes last date line)
if ( /^DT\s+(.+)$/ ) {
my $line = $1;
my ($date, $version) = split(' ', $line, 2);
$date =~ tr/,//d; # remove comma if new version
if ($version) {
if ($version =~ /\(Rel\. (\d+), Created\)/xms ) {
my $release = Bio::Annotation::SimpleValue->new(
-tagname => 'creation_release',
-value => $1
);
$annotation->add_Annotation($release);
} elsif ($version =~ /\(Rel\. (\d+), Last updated, Version (\d+)\)/xms ) {
my $release = Bio::Annotation::SimpleValue->new(
-tagname => 'update_release',
-value => $1
);
$annotation->add_Annotation($release);
my $update = Bio::Annotation::SimpleValue->new(
-tagname => 'update_version',
-value => $2
);
$annotation->add_Annotation($update);
}
}
push @{$params{'-dates'}}, $date;
}
#keywords
if ( /^KW (.*)\S*$/ ) {
my @kw = split(/\s*\;\s*/,$1);
push @{$params{'-keywords'}}, @kw;
}
# Organism name and phylogenetic information
elsif (/^O[SC]/) {
# pass the accession number so we can give an informative throw message if necessary
my $species = $self->_read_EMBL_Species(\$buffer, $params{'-accession_number'});
$params{'-species'}= $species;
}
# NCBI TaxID Xref
elsif (/^OX/) {
if (/NCBI_TaxID=(\d+)/) {
$ncbi_taxid=$1;
}
my @links = $self->_read_EMBL_TaxID_DBLink(\$buffer);
foreach my $dblink ( @links ) {
$annotation->add_Annotation('dblink',$dblink);
}
}
# References
elsif (/^R/) {
my @refs = $self->_read_EMBL_References(\$buffer);
foreach my $ref ( @refs ) {
$annotation->add_Annotation('reference',$ref);
}
}
# DB Xrefs
elsif (/^DR/) {
my @links = $self->_read_EMBL_DBLink(\$buffer);
foreach my $dblink ( @links ) {
$annotation->add_Annotation('dblink',$dblink);
}
}
# Comments
elsif (/^CC\s+(.*)/) {
$comment .= $1;
$comment .= " ";
while (defined ($_ = $self->_readline) ) {
if (/^CC\s+(.*)/) {
$comment .= $1;
$comment .= " ";
} else {
last;
}
}
my $commobj = Bio::Annotation::Comment->new();
$commobj->text($comment);
$annotation->add_Annotation('comment',$commobj);
$comment = "";
}
# Get next line.
$buffer = $self->_readline;
}
while ( defined ($_ = $self->_readline) ) {
/^FT\s{3}\w/ && last;
/^SQ / && last;
/^CO / && last;
}
$buffer = $_;
if (defined($buffer) && $buffer =~ /^FT /) {
until ( !defined ($buffer) ) {
my $ftunit = $self->_read_FTHelper_EMBL(\$buffer);
# process ftunit
my $feat =
$ftunit->_generic_seqfeature($self->location_factory(), $name);
# add taxon_id from source if available
# Notice, this will override what is found in the OX line.
# this is by design as this seems to be the official way
# of specifying a TaxID
if ($params{'-species'} && ($feat->primary_tag eq 'source')
&& $feat->has_tag('db_xref')
&& (! $params{'-species'}->ncbi_taxid())) {
foreach my $tagval ($feat->get_tag_values('db_xref')) {
if (index($tagval,"taxon:") == 0) {
$params{'-species'}->ncbi_taxid(substr($tagval,6));
last;
}
}
}
# add feature to list of features
push(@features, $feat);
if ( $buffer !~ /^FT/ ) {
last;
}
}
}
# Set taxid found in OX line
if ($params{'-species'} && defined $ncbi_taxid
&& (! $params{'-species'}->ncbi_taxid())) {
$params{'-species'}->ncbi_taxid($ncbi_taxid);
}
# skip comments
while ( defined ($buffer) && $buffer =~ /^XX/ ) {
$buffer = $self->_readline();
}
if ( $buffer =~ /^CO/ ) {
# bug#2982
# special : create contig as annotation
while ( defined ($buffer) ) {
$annotation->add_Annotation($_) for $self->_read_EMBL_Contig(\$buffer);
if ( !$buffer || $buffer !~ /^CO/ ) {
last;
}
}
$buffer ||= '';
}
if ($buffer !~ /^\/\//) { # if no SQ lines following CO (bug#2958)
if ( $buffer !~ /^SQ/ ) {
while ( defined ($_ = $self->_readline) ) {
/^SQ/ && last;
}
}
$seqc = "";
while ( defined ($_ = $self->_readline) ) {
m{^//} && last;
$_ = uc($_);
s/[^A-Za-z]//g;
$seqc .= $_;
}
}
my $seq = $self->sequence_factory->create
(-verbose => $self->verbose(),
-division => $div,
-seq => $seqc,
-desc => $desc,
-display_id => $name,
-annotation => $annotation,
-molecule => $mol,
-alphabet => $alphabet,
-features => \@features,
%params);
return $seq;
}
=head2 _write_ID_line
Title : _write_ID_line
Usage : $self->_write_ID_line($seq);
Function: Writes the EMBL Release 87 format ID line to the stream, unless
: there is a user-supplied ID line generation function in which
: case that is used instead.
: ( See Bio::SeqIO::embl::_id_generation_function(). )
Returns : nothing
Args : Bio::Seq object
=cut
sub _write_ID_line {
my ($self, $seq) = @_;
my $id_line;
# If there is a user-supplied ID generation function, use it.
if ( $self->_id_generation_func ) {
$id_line = "ID " . &{$self->_id_generation_func}($seq) . "\nXX\n";
}
# Otherwise, generate a standard EMBL release 87 (June 2006) ID line.
else {
# The sequence name is supposed to be the primary accession number,
my $name = $seq->accession_number();
if ( not(defined $name) || $name eq 'unknown') {
# but if it is not present, use the sequence ID or the empty string
$name = $seq->id() || '';
}
$self->warn("No whitespace allowed in EMBL id [". $name. "]") if $name =~ /\s/;
# Use the sequence version, or default to 1.
my $version = $seq->version() || 1;
my $len = $seq->length();
# Taxonomic division.
my $div;
if ( $seq->can('division') && defined($seq->division) &&
$self->_is_valid_division($seq->division) ) {
$div = $seq->division();
} else {
$div ||= 'UNC'; # 'UNC' is the EMBL division code for 'unclassified'.
}
my $mol;
# If the molecule type is a valid EMBL type, use it.
if ( $seq->can('molecule')
&& defined($seq->molecule)
&& $self->_is_valid_molecule_type($seq->molecule)
) {
$mol = $seq->molecule();
}
# Otherwise, choose unassigned DNA or RNA based on the alphabet.
elsif ($seq->can('primary_seq') && defined $seq->primary_seq->alphabet) {
my $alphabet =$seq->primary_seq->alphabet;
if ($alphabet eq 'dna') {
$mol ='unassigned DNA';
} elsif ($alphabet eq 'rna') {
$mol='unassigned RNA';
} elsif ($alphabet eq 'protein') {
$self->warn("Protein sequence found; EMBL is a nucleotide format.");
$mol='AA'; # AA is not a valid EMBL molecule type.
}
}
my $topology = 'linear';
if ($seq->is_circular) {
$topology = 'circular';
}
$mol ||= ''; # 'unassigned'; ?
$id_line = "ID $name; SV $version; $topology; $mol; STD; $div; $len BP.\nXX\n";
$self->_print($id_line);
}
}
=head2 _is_valid_division
Title : _is_valid_division
Usage : $self->_is_valid_division($div)
Function: tests division code for validity
Returns : true if $div is a valid EMBL release 87 taxonomic division.
Args : taxonomic division code string
=cut
sub _is_valid_division {
my ($self, $division) = @_;
my %EMBL_divisions = (
"PHG" => 1, # Bacteriophage
"ENV" => 1, # Environmental Sample
"FUN" => 1, # Fungal
"HUM" => 1, # Human
"INV" => 1, # Invertebrate
"MAM" => 1, # Other Mammal
"VRT" => 1, # Other Vertebrate
"MUS" => 1, # Mus musculus
"PLN" => 1, # Plant
"PRO" => 1, # Prokaryote
"ROD" => 1, # Other Rodent
"SYN" => 1, # Synthetic
"UNC" => 1, # Unclassified
"VRL" => 1 # Viral
);
return exists($EMBL_divisions{$division});
}
=head2 _is_valid_molecule_type
Title : _is_valid_molecule_type
Usage : $self->_is_valid_molecule_type($mol)
Function: tests molecule type for validity
Returns : true if $mol is a valid EMBL release 87 molecule type.
Args : molecule type string
=cut
sub _is_valid_molecule_type {
my ($self, $moltype) = @_;
my %EMBL_molecule_types = (
"genomic DNA" => 1,
"genomic RNA" => 1,
"mRNA" => 1,
"tRNA" => 1,
"rRNA" => 1,
"snoRNA" => 1,
"snRNA" => 1,
"scRNA" => 1,
"pre-RNA" => 1,
"other RNA" => 1,
"other DNA" => 1,
"unassigned DNA" => 1,
"unassigned RNA" => 1
);
return exists($EMBL_molecule_types{$moltype});
}
=head2 write_seq
Title : write_seq
Usage : $stream->write_seq($seq)
Function: writes the $seq object (must be seq) to the stream
Returns : 1 for success and undef for error
Args : array of 1 to n Bio::SeqI objects
=cut
sub write_seq {
my ($self,@seqs) = @_;
foreach my $seq ( @seqs ) {
$self->throw("Attempting to write with no seq!") unless defined $seq;
unless ( ref $seq && $seq->isa('Bio::SeqI' ) ) {
$self->warn("$seq is not a SeqI compliant sequence object!")
if $self->verbose >= 0;
unless ( ref $seq && $seq->isa('Bio::PrimarySeqI' ) ) {
$self->throw("$seq is not a PrimarySeqI compliant sequence object!");
}
}
my $str = $seq->seq || '';
# Write the ID line.
$self->_write_ID_line($seq);
# Write the accession line if present
my( $acc );
{
if ( my $func = $self->_ac_generation_func ) {
$acc = &{$func}($seq);
} elsif ( $seq->isa('Bio::Seq::RichSeqI') &&
defined($seq->accession_number) ) {
$acc = $seq->accession_number;
$acc = join("; ", $acc, $seq->get_secondary_accessions);
} elsif ( $seq->can('accession_number') ) {
$acc = $seq->accession_number;
}
if (defined $acc) {
$self->_print("AC $acc;\n",
"XX\n") || return;
}
}
# Date lines
my $switch=0;
if ( $seq->can('get_dates') ) {
my @dates = $seq->get_dates();
my $ct = 1;
my $date_flag = 0;
my ($cr) = $seq->annotation->get_Annotations("creation_release");
my ($ur) = $seq->annotation->get_Annotations("update_release");
my ($uv) = $seq->annotation->get_Annotations("update_version");
unless ($cr && $ur && $ur) {
$date_flag = 1;
}
foreach my $dt (@dates) {
if (!$date_flag) {
$self->_write_line_EMBL_regex("DT ","DT ",
$dt." (Rel. $cr, Created)",
'\s+|$',80) if $ct == 1;
$self->_write_line_EMBL_regex("DT ","DT ",
$dt." (Rel. $ur, Last updated, Version $uv)",
'\s+|$',80) if $ct == 2;
} else { # other formats?
$self->_write_line_EMBL_regex("DT ","DT ",
$dt,'\s+|$',80);
}
$switch =1;
$ct++;
}
if ($switch == 1) {
$self->_print("XX\n") || return;
}
}
# Description lines
$self->_write_line_EMBL_regex("DE ","DE ",$seq->desc(),'\s+|$',80) || return; #'
$self->_print( "XX\n") || return;
# if there, write the kw line
{
my( $kw );
if ( my $func = $self->_kw_generation_func ) {
$kw = &{$func}($seq);
} elsif ( $seq->can('keywords') ) {
$kw = $seq->keywords;
}
if (defined $kw) {
$self->_write_line_EMBL_regex("KW ", "KW ", $kw, '\s+|$', 80) || return; #'
$self->_print( "XX\n") || return;
}
}
# Organism lines
if ($seq->can('species') && (my $spec = $seq->species)) {
my @class = $spec->classification();
shift @class; # get rid of species name. Some embl files include
# the species name in the OC lines, but this seems
# more like an error than something we need to
# emulate
my $OS = $spec->scientific_name;
if ($spec->common_name) {
$OS .= ' ('.$spec->common_name.')';
}
$self->_print("OS $OS\n") || return;
my $OC = join('; ', reverse(@class)) .'.';
$self->_write_line_EMBL_regex("OC ","OC ",$OC,'; |$',80) || return;
if ($spec->organelle) {
$self->_write_line_EMBL_regex("OG ","OG ",$spec->organelle,'; |$',80) || return;
}
my $ncbi_taxid = $spec->ncbi_taxid;
if ($ncbi_taxid) {
$self->_print("OX NCBI_TaxID=$ncbi_taxid\n") || return;
}
$self->_print("XX\n") || return;
}
# Reference lines
my $t = 1;
if ( $seq->can('annotation') && defined $seq->annotation ) {
foreach my $ref ( $seq->annotation->get_Annotations('reference') ) {
$self->_print( "RN [$t]\n") || return;
# Having no RP line is legal, but we need both
# start and end for a valid location.
if ($ref->comment) {
$self->_write_line_EMBL_regex("RC ", "RC ", $ref->comment, '\s+|$', 80) || return; #'
}
my $start = $ref->start;
my $end = $ref->end;
if ($start and $end) {
$self->_print( "RP $start-$end\n") || return;
} elsif ($start or $end) {
$self->throw("Both start and end are needed for a valid RP line.".
" Got: start='$start' end='$end'");
}
if (my $med = $ref->medline) {
$self->_print( "RX MEDLINE; $med.\n") || return;
}
if (my $pm = $ref->pubmed) {
$self->_print( "RX PUBMED; $pm.\n") || return;
}
my $authors = $ref->authors;
$authors =~ s/([\w\.]) (\w)/$1#$2/g; # add word wrap protection char '#'
$self->_write_line_EMBL_regex("RA ", "RA ",
$authors . ";",
'\s+|$', 80) || return; #'
# If there is no title to the reference, it appears
# as a single semi-colon. All titles must end in
# a semi-colon.
my $ref_title = $ref->title || '';
$ref_title =~ s/[\s;]*$/;/;
$self->_write_line_EMBL_regex("RT ", "RT ", $ref_title, '\s+|$', 80) || return; #'
$self->_write_line_EMBL_regex("RL ", "RL ", $ref->location, '\s+|$', 80) || return; #'
$self->_print("XX\n") || return;
$t++;
}
# DB Xref lines
if (my @db_xref = $seq->annotation->get_Annotations('dblink') ) {
for my $dr (@db_xref) {
my $db_name = $dr->database;
my $prim = $dr->primary_id;
my $opt = $dr->optional_id || '';
my $line = $opt ? "$db_name; $prim; $opt." : "$db_name; $prim.";
$self->_write_line_EMBL_regex("DR ", "DR ", $line, '\s+|$', 80) || return; #'
}
$self->_print("XX\n") || return;
}
# Comment lines
foreach my $comment ( $seq->annotation->get_Annotations('comment') ) {
$self->_write_line_EMBL_regex("CC ", "CC ", $comment->text, '\s+|$', 80) || return; #'
$self->_print("XX\n") || return;
}
}
# "\\s\+\|\$"
## FEATURE TABLE
$self->_print("FH Key Location/Qualifiers\n") || return;
$self->_print("FH\n") || return;
my @feats = $seq->can('top_SeqFeatures') ? $seq->top_SeqFeatures : ();
if ($feats[0]) {
if ( defined $self->_post_sort ) {
# we need to read things into an array.
# Process. Sort them. Print 'em
my $post_sort_func = $self->_post_sort();
my @fth;
foreach my $sf ( @feats ) {
push(@fth,Bio::SeqIO::FTHelper::from_SeqFeature($sf,$seq));
}
@fth = sort { &$post_sort_func($a,$b) } @fth;
foreach my $fth ( @fth ) {
$self->_print_EMBL_FTHelper($fth) || return;
}
} else {
# not post sorted. And so we can print as we get them.
# lower memory load...
foreach my $sf ( @feats ) {
my @fth = Bio::SeqIO::FTHelper::from_SeqFeature($sf,$seq);
foreach my $fth ( @fth ) {
if ( $fth->key eq 'CONTIG') {
$self->_show_dna(0);
}
$self->_print_EMBL_FTHelper($fth) || return;
}
}
}
}
if ( $self->_show_dna() == 0 ) {
$self->_print( "//\n") || return;
return;
}
$self->_print( "XX\n") || return;
# finished printing features.
# print contig if present : bug#2982
if ( $seq->can('annotation') && defined $seq->annotation) {
foreach my $ctg ( $seq->annotation->get_Annotations('contig') ) {
if ($ctg->value) {
$self->_write_line_EMBL_regex("CO ","CO ", $ctg->value,
'[,]|$', 80) || return;
}
}
}
# print sequence lines only if sequence is present! bug#2982
if (length($str)) {
$str =~ tr/A-Z/a-z/;
# Count each nucleotide
my $alen = $str =~ tr/a/a/;
my $clen = $str =~ tr/c/c/;
my $glen = $str =~ tr/g/g/;
my $tlen = $str =~ tr/t/t/;
my $len = $seq->length();
my $olen = $seq->length() - ($alen + $tlen + $clen + $glen);
if ( $olen < 0 ) {
$self->warn("Weird. More atgc than bases. Problem!");
}
$self->_print("SQ Sequence $len BP; $alen A; $clen C; $glen G; $tlen T; $olen other;\n") || return;
my $nuc = 60; # Number of nucleotides per line
my $whole_pat = 'a10' x 6; # Pattern for unpacking a whole line
my $out_pat = 'A11' x 6; # Pattern for packing a line
my $length = length($str);
# Calculate the number of nucleotides which fit on whole lines
my $whole = int($length / $nuc) * $nuc;
# Print the whole lines
my( $i );
for ($i = 0; $i < $whole; $i += $nuc) {
my $blocks = pack $out_pat,
unpack $whole_pat,
substr($str, $i, $nuc);
$self->_print(sprintf(" $blocks%9d\n", $i + $nuc)) || return;
}
# Print the last line
if (my $last = substr($str, $i)) {
my $last_len = length($last);
my $last_pat = 'a10' x int($last_len / 10) .'a'. $last_len % 10;
my $blocks = pack $out_pat,
unpack($last_pat, $last);
$self->_print(sprintf(" $blocks%9d\n", $length)) ||
return; # Add the length to the end
}
}
$self->_print( "//\n") || return;
$self->flush if $self->_flush_on_write && defined $self->_fh;
}
return 1;
}
=head2 _print_EMBL_FTHelper
Title : _print_EMBL_FTHelper
Usage :
Function: Internal function
Returns : 1 if writing suceeded, otherwise undef
Args :
=cut
sub _print_EMBL_FTHelper {
my ($self,$fth) = @_;
if ( ! ref $fth || ! $fth->isa('Bio::SeqIO::FTHelper') ) {
$fth->warn("$fth is not a FTHelper class. Attempting to print, but there could be tears!");
}
#$self->_print( "FH Key Location/Qualifiers\n");
#$self->_print( sprintf("FT %-15s %s\n",$fth->key,$fth->loc));
# let
if ( $fth->key eq 'CONTIG' ) {
$self->_print("XX\n") || return;
$self->_write_line_EMBL_regex("CO ",
"CO ",$fth->loc,
'\,|$',80) || return; #'
return 1;
}
$self->_write_line_EMBL_regex(sprintf("FT %-15s ",$fth->key),
"FT ",$fth->loc,
'\,|$',80) || return; #'
foreach my $tag ( keys %{$fth->field} ) {
if ( ! defined $fth->field->{$tag} ) {
next;
}
foreach my $value ( @{$fth->field->{$tag}} ) {
$value =~ s/\"/\"\"/g;
if ($value eq "_no_value") {
$self->_write_line_EMBL_regex("FT ",
"FT ",
"/$tag",'.|$',80) || return; #'
}
# there are almost 3x more quoted qualifier values and they
# are more common too so we take quoted ones first
#
# Long qualifiers, that will be line wrapped, are always quoted
elsif (!$FTQUAL_NO_QUOTE{$tag} or length("/$tag=$value")>=60) {
my $pat = $value =~ /\s/ ? '\s|\-|$' : '.|\-|$';
$self->_write_line_EMBL_regex("FT ",
"FT ",
"/$tag=\"$value\"",$pat,80) || return;
} else {
$self->_write_line_EMBL_regex("FT ",
"FT ",
"/$tag=$value",'.|$',80) || return; #'
}
}
}
return 1;
}
=head2 _read_EMBL_Contig()
Title : _read_EMBL_Contig
Usage :
Function: convert CO lines into annotations
Returns :
Args :
=cut
sub _read_EMBL_Contig {
my ($self, $buffer) = @_;