3 # Copyright (C) 2007-2011 Martin A. Hansen.
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.
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.
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.
19 # http://www.gnu.org/copyleft/gpl.html
21 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
23 # This program is part of the Biopieces framework (www.biopieces.org).
25 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> DESCRIPTION <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
27 # Remove adaptors or parts thereof from sequences in the stream.
29 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
37 def disambiguate(adaptor)
38 adaptor_disamb = adaptor.dup
39 adaptor_disamb.gsub!('U', 'T')
40 adaptor_disamb.gsub!('R', '[AG]')
41 adaptor_disamb.gsub!('Y', '[CT]')
42 adaptor_disamb.gsub!('S', '[GC]')
43 adaptor_disamb.gsub!('W', '[AT]')
44 adaptor_disamb.gsub!('M', '[AC]')
45 adaptor_disamb.gsub!('K', '[GT]')
46 adaptor_disamb.gsub!('V', '[ACG]')
47 adaptor_disamb.gsub!('H', '[ACT]')
48 adaptor_disamb.gsub!('D', '[AGT]')
49 adaptor_disamb.gsub!('B', '[CGT]')
50 adaptor_disamb.gsub!('N', '.')
55 # Method that finds an adaptor or part thereof in the sequence of a Seq object.
56 # Returns a Match object if the adaptor was found otherwise nil. The ed_percent
57 # indicates the maximum edit distance allowed in all possible overlaps.
58 def adaptor_find(adaptor, adaptor_disamb, pos = 0, ed_percent = 0)
59 raise SeqError, "Edit distance percent out of range #{ed_percent}" unless (0 .. 100).include? ed_percent
62 pos = self.length + pos # pos offset from the right end
66 if match = adaptor_find_simple(adaptor_disamb, pos)
68 elsif match = adaptor_find_complex(adaptor, pos, ed_percent)
70 elsif match = adaptor_partial_find_complex(adaptor, pos, ed_percent)
78 # Method to find an adaptor in a sequence taking into account ambiguity
79 # codes, but not considering mismatches, insertions, and deletions.
80 def adaptor_find_simple(adaptor, pos)
81 self.seq.upcase.match(adaptor, pos) do |m|
82 return Match.new($`.length, m, m.to_s.length, 0, 0, 0, m.to_s.length)
86 # Method to find an adaptor in a sequence taking into account ambiguity
87 # codes, mismatches, insertions, and deletions.
88 def adaptor_find_complex(adaptor, pos, ed_percent)
89 ed_max = (adaptor.length * ed_percent * 0.01).round
91 match = self.match(adaptor, pos, ed_max)
96 # Method to find part of an adaptor at the right end of a sequence taking
97 # into account ambiguity codes, mismatches, insertions, and deletions.
98 def adaptor_partial_find_complex(adaptor, pos, ed_percent)
99 if pos > self.length - adaptor.length
100 adaptor = adaptor[0 ... self.length - pos]
102 adaptor = adaptor[0 ... adaptor.length - 1]
104 pos = self.length - adaptor.length
107 #puts self.seq if VERBOSE
109 while adaptor.length > 0
110 #puts (" " * pos) + adaptor if VERBOSE
112 ed_max = (adaptor.length * ed_percent * 0.01).round
115 self.seq.upcase.match(adaptor, pos) do |m|
116 return Match.new($`.length, m, m.to_s.length, 0, 0, 0, m.to_s.length)
119 self.scan(adaptor, pos, ed_max).each do |match|
124 adaptor = adaptor[0 ... -1]
132 casts << {:long=>'adaptor', :short=>'r', :type=>'string', :mandatory=>false, :default=>nil, :allowed=>nil, :disallowed=>nil}
133 casts << {:long=>'edit_distance', :short=>'e', :type=>'uint', :mandatory=>false, :default=>20, :allowed=>nil, :disallowed=>nil}
134 casts << {:long=>'pos', :short=>'p', :type=>'int', :mandatory=>false, :default=>1, :allowed=>nil, :disallowed=>"0"}
135 casts << {:long=>'cache', :short=>'c', :type=>'flag', :mandatory=>false, :default=>nil, :allowed=>nil, :disallowed=>nil}
139 options = bp.parse(ARGV, casts)
141 adaptor = options[:adaptor].to_s.upcase
142 adaptor_disamb = disambiguate(adaptor)
145 pos -= 1 if pos > 0 # pos was 1-based
149 bp.each_record do |record|
150 if record.has_key? :SEQ
151 entry = Seq.new(record[:SEQ_NAME], record[:SEQ], "dna", record[:SCORES])
153 if cache[entry.seq.upcase] and options[:cache]
154 match = cache[entry.seq.upcase]
156 match = entry.adaptor_find(adaptor, adaptor_disamb, pos, options[:edit_distance])
158 cache[entry.seq.upcase] = match if match and options[:cache]
162 record[:ADAPTOR_POS] = match.pos
163 record[:ADAPTOR_LEN] = match.length
164 record[:ADAPTOR_MATCH] = match.match
172 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<