Module: Bio::RestrictionEnzyme::StringFormatting

Extended by:
CutSymbol
Includes:
CutSymbol
Included in:
DoubleStranded, DoubleStranded, DoubleStranded::AlignedStrands, Range::SequenceRange::CalculatedCuts, SingleStrand
Defined in:
lib/bio/util/restriction_enzyme/string_formatting.rb

Instance Method Summary (collapse)

Methods included from CutSymbol

cut_symbol, escaped_cut_symbol, re_cut_symbol, re_cut_symbol_adjacent, set_cut_symbol

Instance Method Details

- (Object) add_spacing(seq, cs = cut_symbol)

Return the sequence with spacing for alignment. Does not add whitespace around cut symbols.

Example:

pattern = 'n^ng^arraxt^n'
add_spacing( pattern )      # => "n^n g^a r r a x t^n"

Arguments

  • seq: sequence with cut symbols

  • cs: (optional) Cut symbol along the string. The reason this is definable outside of CutSymbol is that this is a utility function used to form vertical and horizontal cuts such as:

    a|t g c
     +---+
    t a c|g

Returns

String sequence with single character distance between bases



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/bio/util/restriction_enzyme/string_formatting.rb', line 38

def add_spacing( seq, cs = cut_symbol )
  str = ''
  flag = false
  seq.each_byte do |c|
    c = c.chr
    if c == cs
      str += c
      flag = false
    elsif flag
      str += ' ' + c
    else
      str += c
      flag = true
    end
  end
  str
end

- (Object) left_padding(s)

Return the 'n' padding on the left side of the strand


Arguments

  • s: sequence with extraneous 'n' padding on the left side of the strand

Returns

String the 'n' padding from the left side



92
93
94
95
96
# File 'lib/bio/util/restriction_enzyme/string_formatting.rb', line 92

def left_padding( s )
  s =~ %r{^n+}
  ret = $&
  ret ? ret : ''  # Don't pass nil values
end

- (Object) right_padding(s)

Return the 'n' padding on the right side of the strand


Arguments

  • s: sequence with extraneous 'n' padding on the right side of the strand

Returns

String the 'n' padding from the right side



104
105
106
107
108
# File 'lib/bio/util/restriction_enzyme/string_formatting.rb', line 104

def right_padding( s )
  s =~ %r{n+$}
  ret = $&
  ret ? ret : ''  # Don't pass nil values
end

- (Object) strip_cuts_and_padding(s)

Remove extraneous nucleic acid wildcards ('n' padding) from the left and right sides and remove cut symbols


Arguments

  • s: sequence with extraneous 'n' padding and cut symbols

Returns

String sequence without 'n' padding on the sides or cut symbols



82
83
84
# File 'lib/bio/util/restriction_enzyme/string_formatting.rb', line 82

def strip_cuts_and_padding( s )
  strip_padding( s.tr(cut_symbol, '') )
end

- (Object) strip_padding(s)

Remove extraneous nucleic acid wildcards ('n' padding) from the left and right sides


Arguments

  • s: sequence with extraneous 'n' padding

Returns

String sequence without 'n' padding on the sides



63
64
65
66
67
68
69
70
71
72
73
# File 'lib/bio/util/restriction_enzyme/string_formatting.rb', line 63

def strip_padding( s )
  if s[0].chr == 'n'
    s =~ %r{(n+)(.+)}
    s = $2
  end
  if s[-1].chr == 'n'
    s =~ %r{(.+?)(n+)$}
    s = $1
  end
  s
end