]> git.donarmstrong.com Git - biopieces.git/blob - bp_bin/find_gaps
added tests for find_gaps
[biopieces.git] / bp_bin / find_gaps
1 #!/usr/bin/env perl
2
3 # Copyright (C) 2007-2010 Martin A. Hansen.
4
5 # This program is free software; you can redistribute it and/or
6 # modify it under the terms of the GNU General Public License
7 # as published by the Free Software Foundation; either version 2
8 # of the License, or (at your option) any later version.
9
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18
19 # http://www.gnu.org/copyleft/gpl.html
20
21
22 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> DESCRIPTION <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
23
24 # Find stretches of N's in sequences from the stream.
25
26 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
27
28
29 use warnings;
30 use strict;
31 use Maasha::Biopieces;
32
33
34 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
35
36
37 my ( $options, $in, $out, $record, $gaps, $gap );
38
39 $options = Maasha::Biopieces::parse_options(
40     [
41         { long => 'min_len', short => 'm', type => 'uint', mandatory => 'no', default => 5, allowed => undef, disallowed => 0 },
42     ]   
43 );
44
45 $in  = Maasha::Biopieces::read_stream( $options->{ "stream_in" } );
46 $out = Maasha::Biopieces::write_stream( $options->{ "stream_out" } );
47
48 while ( $record = Maasha::Biopieces::get_record( $in ) )
49 {
50     Maasha::Biopieces::put_record( $record, $out );
51
52     if ( exists $record->{ 'SEQ' } )
53     {
54         $gaps = find_gaps( $record->{ 'SEQ' }, $options->{ 'min_len' } );
55
56         foreach $gap ( @{ $gaps } )
57         {
58             $gap->{ 'S_ID' } = $record->{ 'S_ID' } || $record->{ 'SEQ_NAME' };
59
60             Maasha::Biopieces::put_record( $gap, $out ); 
61         }
62     }
63 }
64
65 Maasha::Biopieces::close_stream( $in );
66 Maasha::Biopieces::close_stream( $out );
67
68
69 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> SUBROUTINES <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
70
71
72 sub find_gaps
73 {
74     # Martin A. Hansen, March 2010.
75     
76     # Find  stretches, larger than or equal to a given minimum
77     # of N's in a sequence, and returns a list of intervals
78     # with these.
79
80     my ( $seq,   # Sequence
81          $min,   # Minimum stretch length
82        ) = @_;
83
84     # Returns a list.
85
86     my ( @gaps, $block, $beg, $end );
87
88     $seq = uc $seq;
89
90     $block = 'N' x $min;
91
92     $beg = 0;
93
94     while ( 1 )
95     {
96         $beg = index $seq, $block, $beg;
97
98         last if $beg < 0;
99
100         $end = $beg;
101
102         while ( substr( $seq, $end, 1 ) eq 'N' ) {
103             $end++;
104         }
105
106         push @gaps, {
107             S_BEG => $beg,
108             S_END => $end - 1,
109             S_LEN => $end - $beg,
110         };
111
112         $beg = $end + 1;
113     }
114
115     return wantarray ? @gaps : \@gaps;
116 }
117
118
119 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
120
121
122 BEGIN
123 {
124     Maasha::Biopieces::status_set();
125 }
126
127
128 END
129 {
130     Maasha::Biopieces::status_log();
131 }
132
133
134 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
135
136
137 __END__