Class: Bioroebe::ShowRestrictionEnzymes

Inherits:
Base
  • Object
show all
Defined in:
lib/bioroebe/enzymes/show_restriction_enzymes.rb

Overview

Bioroebe::ShowRestrictionEnzymes

Constant Summary

Constants inherited from Base

Base::NAMESPACE

Constants included from ColoursForBase

ColoursForBase::ARRAY_HTML_COLOURS_IN_USE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#append_what_into, #can_base_pair?, #convert_global_env, #delete_file, #directory_to_the_codon_tables?, #file_readlines, #infer_the_namespace, #is_on_roebe?, #is_palindrome?, #main_encoding?, #mkdir, #move_file, #mv, #namespace?, #no_file_exists_at, #no_newlines, #project_yaml_directory?, #rds, #register_sigint, #return_pwd, #return_the_first_line_of_this_file, #word_wrap, #write_what_into

Methods included from ColoursForBase

#colourize_this_aminoacid_sequence_for_the_commandline, #colourize_this_nucleotide_sequence, #disable_colours, #ecomment, #efancy, #egold, #enable_colours, #eorange, #eparse, #erev, #red, #remove_trailing_escape_part, #return_colour_for_nucleotides, #rev, #sdir, #set_use_colours, #sfancy, #sfile, #simp, #swarn, #use_colours?, #use_colours_within_the_bioroebe_namespace?

Constructor Details

#initialize(run_already = true) ⇒ ShowRestrictionEnzymes

#

initialize

#

29
30
31
32
33
34
# File 'lib/bioroebe/enzymes/show_restriction_enzymes.rb', line 29

def initialize(
    run_already = true
  )
  reset
  run if run_already
end

Class Method Details

.[](i = '') ⇒ Object

#

Bioroebe::ShowRestrictionEnzymes[]

#

100
101
102
# File 'lib/bioroebe/enzymes/show_restriction_enzymes.rb', line 100

def self.[](i = '')
  new(i)
end

Instance Method Details

#colourize_value(i) ⇒ Object

#

colourize_value

We delegate to crimson() for the colour, but only if we actually make use of colours.

#

77
78
79
80
81
82
83
84
85
86
87
# File 'lib/bioroebe/enzymes/show_restriction_enzymes.rb', line 77

def colourize_value(i)
  if use_colours?
    i = slateblue(i)
    if i.include? ' ' # Here we also assume that this has at least one number.
      splitted = i.split ' '
      splitted[-1] = crimson(splitted[-1]) # Colourize the number red.
      i = splitted.join ' '
    end
  end
  i
end

#notify_the_user_about_the_available_restriction_enzymesObject

#

notify_the_user_about_the_available_restriction_enzymes

#

50
51
52
53
54
55
56
57
58
59
60
# File 'lib/bioroebe/enzymes/show_restriction_enzymes.rb', line 50

def notify_the_user_about_the_available_restriction_enzymes
  erev 'Available Restriction Enzymes (from file '+
        sfile(::Bioroebe.restriction_enzymes_file)+'):'
  # ======================================================================= #
  # Obtain all restriction enzymes next, in Array form.
  # ======================================================================= #
  ::Bioroebe.restriction_enzymes(:array_format).each {|key,value|
    _ = ('%15s' % key)
    erev _+seagreen('')+rev+colourize_value(value)
  }
end

#report_how_many_restriction_enzymes_were_foundObject

#

report_how_many_restriction_enzymes_were_found

#

65
66
67
68
69
# File 'lib/bioroebe/enzymes/show_restriction_enzymes.rb', line 65

def report_how_many_restriction_enzymes_were_found
  n_enzymes = ::Bioroebe.restriction_enzymes.size.to_s
  erev "A total of #{sfancy(n_enzymes)}#{rev} "\
       "registered restrictions-enzymes were found."
end

#resetObject

#

reset

#

39
40
41
42
43
44
45
# File 'lib/bioroebe/enzymes/show_restriction_enzymes.rb', line 39

def reset
  super()
  # ======================================================================= #
  # === @use_colours
  # ======================================================================= #
  @use_colours = true
end

#runObject

#

run (run tag)

#

92
93
94
95
# File 'lib/bioroebe/enzymes/show_restriction_enzymes.rb', line 92

def run
  notify_the_user_about_the_available_restriction_enzymes
  report_how_many_restriction_enzymes_were_found
end