Module: Bio::RestrictionEnzyme::CutSymbol
- Included in:
- Bio::RestrictionEnzyme
- Defined in:
- lib/bio/util/restriction_enzyme/cut_symbol.rb
Overview
Usage
#require 'bio/util/restriction_enzyme/cut_symbol'
require 'cut_symbol'
include Bio::RestrictionEnzyme::CutSymbol
cut_symbol # => "^"
set_cut_symbol('|') # => "|"
cut_symbol # => "|"
escaped_cut_symbol # => "\\|"
re_cut_symbol # => /\|/
set_cut_symbol('^') # => "^"
"abc^de" =~ re_cut_symbol # => 3
"abc^de" =~ re_cut_symbol_adjacent # => nil
"abc^^de" =~ re_cut_symbol_adjacent # => 3
"a^bc^^de" =~ re_cut_symbol_adjacent # => 4
"a^bc^de" =~ re_cut_symbol_adjacent # => nil
Defined Under Namespace
Classes: CutSymbol__
Instance Method Summary (collapse)
-
- (Object) cut_symbol
Get the token that's used as the cut symbol in a restriction enzyme sequece.
-
- (Object) escaped_cut_symbol
Get the token that's used as the cut symbol in a restriction enzyme sequece with a back-slash preceding it.
-
- (Object) re_cut_symbol
A Regexp of the cut_symbol.
-
- (Object) re_cut_symbol_adjacent
Used to check if multiple cut symbols are next to each other.
-
- (Object) set_cut_symbol(glyph)
Set the token to be used as the cut symbol in a restriction enzyme sequece.
Instance Method Details
- (Object) cut_symbol
Get the token that's used as the cut symbol in a restriction enzyme sequece
Arguments
-
none
Returns |
glyph |
52 |
# File 'lib/bio/util/restriction_enzyme/cut_symbol.rb', line 52 def cut_symbol; CutSymbol__.cut_symbol; end |
- (Object) escaped_cut_symbol
Get the token that's used as the cut symbol in a restriction enzyme sequece with a back-slash preceding it.
Arguments
-
none
Returns |
\glyph |
61 |
# File 'lib/bio/util/restriction_enzyme/cut_symbol.rb', line 61 def escaped_cut_symbol; CutSymbol__.escaped_cut_symbol; end |
- (Object) re_cut_symbol
A Regexp of the cut_symbol.
Arguments
-
none
Returns |
RegExp |
79 80 81 |
# File 'lib/bio/util/restriction_enzyme/cut_symbol.rb', line 79 def re_cut_symbol %r"#{escaped_cut_symbol}" end |
- (Object) re_cut_symbol_adjacent
Used to check if multiple cut symbols are next to each other.
Arguments
-
none
Returns |
RegExp |
69 70 71 |
# File 'lib/bio/util/restriction_enzyme/cut_symbol.rb', line 69 def re_cut_symbol_adjacent %r"#{escaped_cut_symbol}{2}" end |
- (Object) set_cut_symbol(glyph)
Set the token to be used as the cut symbol in a restriction enzyme sequece
Starts as ^ character
Arguments
-
glyph: The single character to be used as the cut symbol in an enzyme sequence
Returns |
glyph |
42 43 44 |
# File 'lib/bio/util/restriction_enzyme/cut_symbol.rb', line 42 def set_cut_symbol(glyph) CutSymbol__.cut_symbol = glyph end |