Class: Bioroebe::ShowThisDNASequence

Inherits:
CommandlineApplication show all
Defined in:
lib/bioroebe/utility_scripts/show_this_dna_sequence.rb

Overview

Bioroebe::ShowThisDNASequence

Constant Summary collapse

DEFAULT_STRING =
#

DEFAULT_STRING

#
'GATCGC'

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, #opne, #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, #set_be_verbose, #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 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_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?, #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

Constructor Details

#initialize(i = DEFAULT_STRING, run_already = true) ⇒ ShowThisDNASequence

#

initialize

#

34
35
36
37
38
39
40
41
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 34

def initialize(
    i           = DEFAULT_STRING,
    run_already = true
  )
  reset
  set_input(i)
  run if run_already
end

Class Method Details

.[](i) ⇒ Object

#

ShowThisDNASequence[]

#

140
141
142
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 140

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

Instance Method Details

#input?Boolean

#

input?

#

Returns:

  • (Boolean)

78
79
80
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 78

def input?
  @input
end

#leading_three_primeObject

#

leading_three_prime

#

109
110
111
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 109

def leading_three_prime
  "3' "
end

#reportObject

#

report (report tag)

#

123
124
125
126
127
128
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 123

def report
  e if @use_two_newlines_when_displaying_the_result
  show_the_input_sequence
  show_the_complementary_sequence
  e if @use_two_newlines_when_displaying_the_result
end

#resetObject

#

reset

#

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 46

def reset
  super()
  # ======================================================================= #
  # === @padding
  # ======================================================================= #
  @padding = '  '.dup
  # ======================================================================= #
  # === @use_two_newlines_when_displaying_the_result
  #
  # If this variable is set to true then we will use a newline before
  # we output anything, and another newline when we have ended the
  # main output. This thus creates a little "spacer", which I think
  # is easier to read on the commandline.
  # ======================================================================= #
  @use_two_newlines_when_displaying_the_result = true
end

#runObject

#

run (run tag)

#

133
134
135
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 133

def run
  report
end

#set_input(i = DEFAULT_STRING) ⇒ Object

#

set_input

#

66
67
68
69
70
71
72
73
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 66

def set_input(i = DEFAULT_STRING)
  if i.is_a? Array
    i = i.join.strip
  end
  i = i.dup if i
  i = DEFAULT_STRING if i.nil?
  @input = i
end

#show_the_complementary_sequenceObject

#

show_the_complementary_sequence

#

96
97
98
99
100
101
102
103
104
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 96

def show_the_complementary_sequence
  erev @padding+
       leading_three_prime+
       colourize_this_nucleotide_sequence(
         return_the_complementary_nucleotide_sequence_to(@input)
       )+
       rev+
       trailing_five_prime
end

#show_the_input_sequenceObject

#

show_the_input_sequence

#

85
86
87
88
89
90
91
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 85

def show_the_input_sequence
  erev @padding+
       leading_five_prime+
       colourize_this_nucleotide_sequence(@input)+
       rev+
       trailing_three_prime
end

#trailing_five_primeObject

#

trailing_five_prime

#

116
117
118
# File 'lib/bioroebe/utility_scripts/show_this_dna_sequence.rb', line 116

def trailing_five_prime
  " 5'"
end