Class: Bioroebe::PhredQualityScoreTable

Inherits:
CommandlineApplication show all
Defined in:
lib/bioroebe/ngs/phred_quality_score_table.rb

Overview

Bioroebe::PhredQualityScoreTable

Constant Summary

Constants inherited from CommandlineApplication

CommandlineApplication::OLD_VERBOSE_VALUE

Constants included from ColoursForBase

ColoursForBase::ARRAY_HTML_COLOURS_IN_USE

Constants inherited from Base

Base::NAMESPACE

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CommandlineApplication

#all_aminoacids?, #append_what_into, #at_home?, #be_silent, #be_verbose?, #cat, #ccliner, #change_directory, #cliner, #codon_table_dataset?, #codon_to_aminoacid, #codons_for?, #colourize_this_dna_sequence, #complement, #cp, #disable_warnings, #download_dir?, #editor?, #enable_warnings, #ensure_that_the_base_directories_exist, #esystem, #extract, #is_this_a_start_codon?, #is_this_a_stop_codon?, #leading_five_prime, #load_bioroebe_yaml_file, #log_directory?, #one_letter_to_long_name, #one_to_three, #only_numbers?, #open_in_browser, #opnerev, #opnn, #pad_with_double_quotes, #pad_with_single_quotes, #partner_nucleotide, #remove_numbers, #remove_trailing_ansii_escape_code, #return_all_possible_start_codons, #return_array_of_one_letter_aminoacids, #return_cheerful_person, #return_chunked_display, #return_ubiquitin_sequence, #runmode?, #set_be_verbose, #set_runmode, #start_codon?, #stop_codons?, #strict_filter_away_invalid_aminoacids, #taxonomy_download_directory?, #three_to_one, #to_rna, #trailing_three_prime, #use_opn?, #verbose_truth, #was_or_were, #without_extname, #write_what_into

Methods included from BaseModule

#absolute_path, #default_file_read, #file_readlines

Methods included from CommandlineArguments

#commandline_arguments?, #commandline_arguments_that_are_files?, #e, #first?, #first_non_hyphen_argument?, #remove_hyphens_from_the_commandline_arguments, #return_commandline_arguments_as_string, #return_commandline_arguments_that_are_not_files, #return_entries_without_two_leading_hyphens, #select_commandline_arguments, #select_entries_starting_with_two_hyphens, #set_commandline_arguments

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_will_we_use_colours, #sfancy, #sfile, #simp, #swarn, #use_colours?, #use_colours_within_the_bioroebe_namespace?

Methods inherited from Base

#append_what_into, #can_base_pair?, #convert_global_env, #delete_file, #directory_to_the_codon_tables?, #is_on_roebe?, #is_palindrome?, #main_encoding?, #mkdir, #move_file, #mv, #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 InternalHashModule

#internal_hash?, #reset_the_internal_hash

Methods included from InferTheNamespaceModule

#infer_the_namespace, #namespace?

Constructor Details

#initialize(i = nil, run_already = true) ⇒ PhredQualityScoreTable

#

initialize

#


40
41
42
43
44
45
46
47
 
# File 'lib/bioroebe/ngs/phred_quality_score_table.rb', line 40

def initialize(
    i           = nil,
    run_already = true
  )
  reset
  set_commandline_arguments(i)
  run if run_already
end

Class Method Details

.[](i = ARGV) ⇒ Object

#

Bioroebe::PhredQualityScoreTable[]

#


115
116
117
 
# File 'lib/bioroebe/ngs/phred_quality_score_table.rb', line 115

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

Instance Method Details

#

print_separator

#


101
102
103
 
# File 'lib/bioroebe/ngs/phred_quality_score_table.rb', line 101

def print_separator
  e @use_this_as_the_separator_token * 80
end

#reset ⇒ Object

#

reset (reset tag)

#


52
53
54
55
56
57
58
 
# File 'lib/bioroebe/ngs/phred_quality_score_table.rb', line 52

def reset
  super()
  # ======================================================================= #
  # === @use_this_as_the_separator_token
  # ======================================================================= #
  @use_this_as_the_separator_token = '―' # Or: '-'
end

#run ⇒ Object

#

run (run tag)

#


108
109
110
 
# File 'lib/bioroebe/ngs/phred_quality_score_table.rb', line 108

def run
  start_the_iteration
end

#start_the_iteration ⇒ Object

#

start_the_iteration

#


63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/bioroebe/ngs/phred_quality_score_table.rb', line 63

def start_the_iteration
  lpad = ' ' * 5
  e
  e steelblue('Phred Quality Score | Probability of incorrect '\
    'base call | Base call accuracy')
  print_separator
  1.upto(60).each {|phred_quality_score|
    probability_of_an_incorrect_base_call = ::Bioroebe.phred_error_probability(phred_quality_score) # 10 ** (- phred_quality_score / 10.0)
    # ===================================================================== #
    # The base call accuracy will be rounded to 5 numbers.
    # ===================================================================== #
    base_call_accuracy = (
      100 - (probability_of_an_incorrect_base_call.to_f * 100.0)
    ).round(5).to_s.ljust(8,'0')
    formatted_probability_of_an_incorrect_base_call =
      '('+probability_of_an_incorrect_base_call.round(8).to_s.rjust(8,'0')+')'
    reversed = 1 / probability_of_an_incorrect_base_call
    colourized_phred_score = sienna(phred_quality_score.to_s.rjust(2))
    # ===================================================================== #
    # Last but not least, output the result.
    # ===================================================================== #
    e lpad+colourized_phred_score+
      rev+'             | '+
      orange('1 in ')+
      orange(reversed.round(5).to_s.ljust(12))+
      ' '+
      rev+
      formatted_probability_of_an_incorrect_base_call.rjust(12)+
      rev+
      '     | '+
      royalblue(base_call_accuracy.to_s+'%')
  }
  print_separator
end