Contents

# Copyright 2014 Ryan Moore
# Contact: [e-mail]
#
# This file is part of parse_fasta.
#
# parse_fasta is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# parse_fasta is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with parse_fasta.  If not, see <http://www.gnu.org/licenses/>.

# Provide some methods for dealing with common tasks regarding
# nucleotide sequences.
class Sequence < String

  # Calculates GC content
  #
  # Calculates GC content by dividing count of G + C divided by count
  # of G + C + T + A + U. If there are both T's and U's in the
  # Sequence, things will get weird, but then again, that wouldn't
  # happen, now would it!
  #
  # @example Get GC of a Sequence
  #   Sequence.new('ACTg').gc #=> 0.5
  # @example Using with FastaFile#each_record
  #   FastaFile.open('reads.fna', 'r').each_record do |header, sequence|
  #     puts [header, sequence.gc].join("\t")
  #   end
  #
  # @return [0] if the Sequence is empty or there are no A, C, T, G or U
  #   present
  # @return [Float] if the GC content is defined for the Sequence
  def gc
    s = self.downcase
    c = s.count('c')
    g = s.count('g')
    t = s.count('t')
    a = s.count('a')
    u = s.count('u')
    
    return 0 if c + g + t + a + u == 0
    return (c + g).quo(c + g + t + a + u).to_f
  end

end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
parse_fasta-1.3.0	lib/parse_fasta/sequence.rb
parse_fasta-1.2.0	lib/parse_fasta/sequence.rb
parse_fasta-1.1.2	lib/parse_fasta/sequence.rb
parse_fasta-1.1.1	lib/parse_fasta/sequence.rb
parse_fasta-1.1.0	lib/parse_fasta/sequence.rb