Class: Bioroebe::GenomePattern

Inherits:
CommandlineApplication show all
Defined in:
lib/bioroebe/genomes/genome_pattern.rb

Overview

Bioroebe::GenomePattern

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

Instance Method Summary collapse

Methods inherited from CommandlineApplication

#all_aminoacids?, #append_what_into, #at_home?, #be_silent, #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 = nil, run_already = true) ⇒ GenomePattern

#

initialize

#

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

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

Instance Method Details

#add_gene(i = :foo) ⇒ Object Also known as: add, <<

#

add_gene

#

91
92
93
94
95
96
97
98
99
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 91

def add_gene(i = :foo)
  _ = array_genes?
  unless _.include? i
    if be_verbose?
      opnn; erev "Now adding the gene `#{sfancy(i.to_s)}#{rev}`."
    end
    _ << i
  end
end

#array_genes? ⇒ Boolean

#

array_genes?

#

Returns:

  • (Boolean) 

84
85
86
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 84

def array_genes?
  @hash[:array_genes]
end

#be_verbose? ⇒ Boolean

#

be_verbose?

#

Returns:

  • (Boolean) 

62
63
64
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 62

def be_verbose?
  @hash[:be_verbose]
end

#cmdline? ⇒ Boolean Also known as: input?

#

cmdline?

#

Returns:

  • (Boolean) 

77
78
79
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 77

def cmdline?
  @hash[:cmdline]
end

#genome? ⇒ Boolean Also known as: genes?

#

genome?

return an Array of all genes available in said organism.

#

Returns:

  • (Boolean) 

107
108
109
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 107

def genome?
  array_genes?
end

#remove_gene(i = :foo, be_verbose = be_verbose?) ) ⇒ Object Also known as: remove

#

remove_gene

Use this method to remove a Gene again.

#

130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 130

def remove_gene(i = :foo, be_verbose = be_verbose?)
  case be_verbose
  when :be_verbose
    be_verbose = true
  end
  _ = array_genes?
  if _.include? i
    if be_verbose
      opnn; erev "Now removing the gene `#{sfancy(i.to_s)}#{rev}`."
    end
    _.delete i
  end
end

#report ⇒ Object

#

report

#

114
115
116
117
118
119
120
121
122
123
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 114

def report
  if genome?.empty?
    opnn; erev 'We have no genes stored.'
  else
    opnn; erev 'We have these genes:'
    genes?.each {|entry|
      opnn; erev '  '+sfancy(entry.to_s)
    }
  end
end

#reset ⇒ Object

#

reset (reset tag)

#

46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 46

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @hash
  # ======================================================================= #
  @hash = {}
  # === :array_genes
  @hash[:array_genes] = []
  # === :be_verbose
  @hash[:be_verbose] = true # If true then we tell the user what we will do.
end

#run ⇒ Object

#

run (run tag)

#

147
148
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 147

def run
end

#set_cmdline(i = '') ⇒ Object

#

set_cmdline

#

69
70
71
72
 
# File 'lib/bioroebe/genomes/genome_pattern.rb', line 69

def set_cmdline(i = '')
  i = [i] unless i.is_a? Array
  @hash[:cmdline] = i
end