code_ruby/lib/maasha/usearch.rb

   1 # Copyright (C) 2011 Martin A. Hansen.
   2
   3 # This program is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU General Public License
   5 # as published by the Free Software Foundation; either version 2
   6 # of the License, or (at your option) any later version.
   7
   8 # This program is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 # GNU General Public License for more details.
  12
  13 # You should have received a copy of the GNU General Public License
  14 # along with this program; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16
  17 # http://www.gnu.org/copyleft/gpl.html
  18
  19 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  20
  21 # This software is part of the Biopieces framework (www.biopieces.org).
  22
  23 # >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>><<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
  24
  25 require 'maasha/fasta'
  26
  27 # Error class for all exceptions to do with Usearch.
  28 class UsearchError < StandardError; end
  29
  30 SORT_LIMIT = 2_000_000_000   # use mergesort for files biggern than 2Gb.
  31
  32 class Usearch
  33   include Enumerable
  34
  35   def initialize(infile, outfile, options)
  36     @infile  = infile
  37     @outfile = outfile
  38     @options = options
  39     @command = []
  40   end
  41
  42   # Method that calls Usearch sorting for sorting a FASTA file
  43   # according to decending sequence length.
  44   def sort_length
  45     # usearch -sort seqs.fasta -output seqs.sorted.fasta
  46     if File.size(@infile) < SORT_LIMIT
  47       @command << "usearch --sort #{@infile} --output #{@infile}.sort"
  48     else
  49       @command << "usearch --mergesort #{@infile} --output #{@infile}.sort"
  50     end
  51
  52                 execute
  53
  54     File.rename "#{@infile}.sort", @infile
  55   end
  56
  57   # Method that calls Usearch sorting for sorting a FASTA file
  58   # according to cluster size.
  59   def sort_size
  60     # usearch -sortsize seqs.fasta -output seqs.sorted.fasta
  61     @command << "usearch --sortsize #{@infile} --output #{@infile}.sort"
  62
  63                 execute
  64
  65     File.rename "#{@infile}.sort", @infile
  66   end
  67
  68         # Method to execute clustering de novo.
  69   def cluster
  70     @command << "usearch --cluster #{@infile} --uc #{@outfile} --id #{@options[:identity]}"
  71
  72                 execute
  73   end
  74
  75   # Method to execute database search.
  76   def usearch
  77     @command << "usearch --query #{@infile} --db #{@options[:database]} --userout #{@outfile}"
  78     @command << "--userfields target+tloz+thiz+query+bits+strand"
  79     @command << "--id #{@options[:identity]}"  if @options.has_key? :identity
  80     @command << "--evalue #{@options[:e_val]}" if @options.has_key? :e_val
  81     @command << "--rev"
  82
  83                 execute
  84   end
  85
  86         # Method to parse a Uclust .uc file and for each line of data
  87         # yield a Biopiece record.
  88   def each_cluster
  89     record = {}
  90
  91     File.open(@outfile, mode="r") do |ios|
  92       ios.each_line do |line|
  93         if line !~ /^#/
  94           fields = line.chomp.split("\t")
  95
  96           next if fields[0] == 'C'
  97
  98           record[:TYPE]     = fields[0]
  99           record[:CLUSTER]  = fields[1].to_i
 100           record[:IDENT]    = fields[3].to_f
 101           record[:Q_ID]     = fields[8]
 102
 103           yield record
 104         end
 105       end
 106     end
 107
 108     self # conventionally
 109   end
 110
 111         # Method to parse a Useach user defined tabular file and for each line of data
 112         # yield a Biopiece record.
 113   def each_hit
 114     record = {}
 115
 116     File.open(@outfile, mode="r") do |ios|
 117       ios.gets   # skip comment line
 118       ios.each_line do |line|
 119         fields = line.chomp.split("\t")
 120
 121         record[:REC_TYPE] = "USEARCH"
 122         record[:S_ID]     = fields[0]
 123         record[:S_BEG]    = fields[1].to_i
 124         record[:S_END]    = fields[2].to_i
 125         record[:Q_ID]     = fields[3]
 126         record[:SCORE]    = fields[4].to_f
 127         record[:STRAND]   = fields[5]
 128
 129         yield record
 130       end
 131     end
 132
 133     self # conventionally
 134   end
 135
 136   private
 137
 138         # Method to execute a command using a system() call.
 139         # The command is composed of bits from the @command variable.
 140         def execute
 141                 @command.unshift "nice -n 19"
 142     @command << "--rev" if @options[:comp]
 143                 @command << "> /dev/null 2>&1" unless @options[:verbose]
 144                 command = @command.join(" ")
 145     system(command)
 146     raise "Command failed: #{command}" unless $?.success?
 147
 148                 @command = []
 149         end
 150 end
 151
 152 __END__
 153