Class: Bioroebe::AlphaHelix

Inherits:
CommandlineApplication show all
Defined in:
lib/bioroebe/protein_structure/alpha_helix.rb

Overview

Bioroebe::AlphaHelix

Constant Summary collapse

PITCH_DISTANCE =
#

PITCH_DISTANCE

#
0.54
FULL_TURN_TAKES_N_AMINO_ACIDS =
#

FULL_TURN_TAKES_N_AMINO_ACIDS

#
3.6
DEFAULT_HOW_MANY_AMINO_ACIDS =
#

DEFAULT_HOW_MANY_AMINO_ACIDS

#
60

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(how_many_amino_acids = DEFAULT_HOW_MANY_AMINO_ACIDS) ⇒ AlphaHelix

#

initialize

#

45
46
47
48
49
50
51
 
# File 'lib/bioroebe/protein_structure/alpha_helix.rb', line 45

def initialize(
    how_many_amino_acids = DEFAULT_HOW_MANY_AMINO_ACIDS
  )
  reset
  set_how_many_amino_acids(how_many_amino_acids)
  do_the_calculation
end

Class Method Details

.length?(i) ⇒ Boolean

#

Bioroebe::AlphaHelix.length?

#

Returns:

  • (Boolean) 

80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/bioroebe/protein_structure/alpha_helix.rb', line 80

def self.length?(i)
  i = i.join.strip if i.is_a? Array
  if i.is_a? String
    i = i.size
  end
  # ========================================================================= #
  # Next calculate that length in an AlphaHelix.
  # ========================================================================= #
  length = (i.to_i / FULL_TURN_TAKES_N_AMINO_ACIDS) * PITCH_DISTANCE
  return length.to_s+' nm'
end

Instance Method Details

#do_the_calculation ⇒ Object

#

do_the_calculation

#

72
73
74
75
 
# File 'lib/bioroebe/protein_structure/alpha_helix.rb', line 72

def do_the_calculation
  result = AlphaHelix.length?(@how_many_amino_acids)
  e result.to_s
end

#reset ⇒ Object

#

reset

#

56
57
58
 
# File 'lib/bioroebe/protein_structure/alpha_helix.rb', line 56

def reset
  super()
end

#set_how_many_amino_acids(i = DEFAULT_HOW_MANY_AMINO_ACIDS) ⇒ Object

#

set_how_many_amino_acids

#

63
64
65
66
67
 
# File 'lib/bioroebe/protein_structure/alpha_helix.rb', line 63

def set_how_many_amino_acids(i = DEFAULT_HOW_MANY_AMINO_ACIDS)
  i = i.first.to_s if i.is_a? Array
  i = DEFAULT_HOW_MANY_AMINO_ACIDS if i.empty?
  @how_many_amino_acids = i.to_i
end