Bio/SeqIO/tab.pm

filter: Statementstmt 92.5% 25 / 27 Branchbran 66.6% 8 / 12 Conditioncond 33.3% 1 / 3 MC/DCmcdc 0.0% 0 / 2 Subroutinesub 100% 5 / 5 Podpod 100% 2 / 2 totaltotal 80.3% 41 / 51 CC 9 SCAR 16.3
CC
9
Cov
81%
write_seq
7.9
next_seq
4.0
BEGIN
1.0
CRAP 5.1
« Bio/SeqIO/mbsout.pm ↑ Summary Bio/Tools/AmpliconSearch.pm »
1 #-----------------------------------------------------------------------------
2 # PACKAGE : Bio::SeqIO::tab
3 # AUTHOR : Philip Lijnzaad <p.lijnzaad@med.uu.nl>
4 # CREATED : Feb 6 2003
5 #
6 # Copyright (c) This module is free software; you can redistribute it
7 # and/or modify it under the same terms as Perl itself.
8 #
9 # _History_
10 #
11 # Ewan Birney <birney@ebi.ac.uk> developed the SeqIO
12 # schema and the first prototype modules.
13 #
14 # This code is based on his Bio::SeqIO::raw
15 #
16 # You may distribute this module under the same terms as perl itself
17  
18 # POD documentation - main docs before the code
19  
20 =head1 NAME
21  
22 Bio::SeqIO::tab - nearly raw sequence file input/output
23 stream. Reads/writes id"\t"sequence"\n"
24  
25 =head1 SYNOPSIS
26  
27 Do not use this module directly. Use it via the L<Bio::SeqIO> class.
28  
29 =head1 DESCRIPTION
30  
31 This object can transform Bio::Seq objects to and from tabbed flat
32 file databases.
33  
34 It is very useful when doing large scale stuff using the Unix command
35 line utilities (grep, sort, awk, sed, split, you name it). Imagine
36 that you have a format converter 'seqconvert' along the following
37 lines:
38  
39 my $in = Bio::SeqIO->newFh(-fh => \*STDIN , '-format' => $from);
40 my $out = Bio::SeqIO->newFh(-fh=> \*STDOUT, '-format' => $to);
41 print $out $_ while <$in>;
42  
43 then you can very easily filter sequence files for duplicates as:
44  
45 $ seqconvert < foo.fa -from fasta -to tab | sort -u |\
46 seqconvert -from tab -to fasta > foo-unique.fa
47  
48 Or grep [-v] for certain sequences with:
49  
50 $ seqconvert < foo.fa -from fasta -to tab | grep -v '^S[a-z]*control' |\
51 seqconvert -from tab -to fasta > foo-without-controls.fa
52  
53 Or chop up a huge file with sequences into smaller chunks with:
54  
55 $ seqconvert < all.fa -from fasta -to tab | split -l 10 - chunk-
56 $ for i in chunk-*; do seqconvert -from tab -to fasta < $i > $i.fa; done
57 # (this creates files chunk-aa.fa, chunk-ab.fa, ..., each containing 10
58 # sequences)
59  
60  
61 =head1 FEEDBACK
62  
63 =head2 Mailing Lists
64  
65 User feedback is an integral part of the evolution of this and other
66 Bioperl modules. Send your comments and suggestions preferably to one
67 of the Bioperl mailing lists. Your participation is much appreciated.
68  
69 bioperl-l@bioperl.org - General discussion
70 http://bioperl.org/wiki/Mailing_lists - About the mailing lists
71  
72 =head2 Support
73  
74 Please direct usage questions or support issues to the mailing list:
75  
76 I<bioperl-l@bioperl.org>
77  
78 rather than to the module maintainer directly. Many experienced and
79 reponsive experts will be able look at the problem and quickly
80 address it. Please include a thorough description of the problem
81 with code and data examples if at all possible.
82  
83 =head2 Reporting Bugs
84  
85 Report bugs to the Bioperl bug tracking system to help us keep track
86 the bugs and their resolution.
87 Bug reports can be submitted via the web:
88  
89 https://github.com/bioperl/bioperl-live/issues
90  
91 =head1 AUTHORS
92  
93 Philip Lijnzaad, p.lijnzaad@med.uu.nl
94  
95 =head1 APPENDIX
96  
97 The rest of the documentation details each of the object methods.
98 Internal methods are usually preceded with a _
99  
100 =cut
101  
102  
103 # Let the code begin...
104  
105 package Bio::SeqIO::tab;
106 3 $Bio::SeqIO::tab::VERSION = '1.7.8';
107 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
108  
109 3 ▶use Bio::Seq;
Subroutine BEGIN: called CC=1 SCAR=0.0
110  
111 3 ▶use base qw(Bio::SeqIO);
Subroutine BEGIN: called CC=1 SCAR=0.0
112  
113 =head2 next_seq
114  
115 Title : next_seq
116 Usage : $seq = $stream->next_seq()
117 Function: returns the next sequence in the stream
118 Returns : Bio::Seq object
119 Args :
120  
121  
122 =cut
123  
124 5 ▶sub next_seq{
Subroutine next_seq: called CC=4 SCAR=14.0
Pod documented
125 5 my ($self,@args) = @_;
126 ## When its 1 sequence per line with no formatting at all,
127 ## grabbing it should be easy :)
128  
129 5 my $nextline = $self->_readline();
130 5 ▶ chomp($nextline) if defined $nextline;
Branch: 1 branch
BranchTrueFalseTotal
if defined $nextline 4 1 5
131 5 ▶ return unless defined $nextline;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $nextline 1 4 5
132 4 ▶ if ($nextline =~ /^([^\t]*)\t(.*)/) {
Branch: 1 branch
BranchTrueFalseTotal
if ($nextline =~ /^([^\t]*)\t(.*)/) { } 4 0 4
133 4 my ($id, $seq)=($1, uc($2));
134 4 $seq =~ s/\s+//g;
135 4 return Bio::Seq->new(-display_id=> $id, -seq => $seq);
136 } else {
137 0 $self->throw("Can't parse tabbed sequence entry:'$nextline' around line $.");
138 }
139 }
140  
141 =head2 write_seq
142  
143 Title : write_seq
144 Usage : $stream->write_seq($seq)
145 Function: writes the $seq object into the stream
146 Returns : 1 for success and 0 for error
147 Args : Bio::Seq object
148  
149  
150 =cut
151  
152 1 ▶sub write_seq {
Subroutine write_seq: called CC=6 SCAR=20.7
Pod documented
153 1 my ($self,@seq) = @_;
154 1 foreach (@seq) {
155 1 ▶ if ($_->display_id() =~ /\t/) {
Branch: 1 branch
BranchTrueFalseTotal
if ($_->display_id =~ /\t/) 0 1 1
156 0 $self->throw("display_id [".$_->display_id()."] contains TAB -- illegal in tab format");
157 }
158 1 ▶ $self->_print($_->display_id(), "\t",$_->seq, "\n") or return;
Branch: 1 branch
BranchTrueFalseTotal
$self->_print($_->display_id, "\t", $_->seq, "\n") or return 1 0 1
159 }
160  
161 1 ▶ $self->flush if $self->_flush_on_write && defined $self->_fh;
Branch: 1 branch
BranchTrueFalseTotal
if $self->_flush_on_write and defined $self->_fh 1 0 1
Condition33%1/3
$self->_flush_on_write and defined $self->_fh
!ll&&!rl&&r
001
MC/DC0%0/2
$self->_flush_on_write and defined $self->_fh
$self->_flush_on_write defined $self->_fh
Truth table33%1/3
A and B
A= $self->_flush_on_writeB= defined $self->_fh
ABresult
0X0
100
111
162 1 return 1;
163 }
164  
165 3 1;
« Bio/SeqIO/mbsout.pm ↑ Summary Bio/Tools/AmpliconSearch.pm »