Module: Bioroebe::Configuration

Defined in:
lib/bioroebe/configuration/constants.rb,
lib/bioroebe/configuration/configuration.rb

Overview

Bioroebe::Configuration

Constant Summary collapse

DEFAULT_EDITOR_TO_USE =

else assume that we may be on windows, so let’s use notepad++ in this event.

'notepad++.exe'
TRY_TO_RENAME_KDE_KONSOLE =
#

TRY_TO_RENAME_KDE_KONSOLE

If the following constant is set to true, then we will try to rename the KDE konsole on startup of the bioroebe shell, if possible.

#
true

Class Method Summary collapse

Class Method Details

.do_not_use_expand_cd_aliases ⇒ Object

#

Bioroebe::Configuration.do_not_use_expand_cd_aliases

#


33
34
35
 
# File 'lib/bioroebe/configuration/configuration.rb', line 33

def self.do_not_use_expand_cd_aliases
  @use_expand_cd_aliases = false
end

.do_use_expand_cd_aliases ⇒ Object

#

Bioroebe::Configuration.do_use_expand_cd_aliases

#


40
41
42
 
# File 'lib/bioroebe/configuration/configuration.rb', line 40

def self.do_use_expand_cd_aliases
  @use_expand_cd_aliases = true
end

.log_user_input? ⇒ Boolean

#

Bioroebe::Configuration.log_user_input?

If the following returns true, then we will log all user-input into a file called ‘history_log.yml’.

#

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/bioroebe/configuration/configuration.rb', line 69

def self.log_user_input?
  true
end

.n_chunks? ⇒ Boolean

#

Bioroebe::Configuration.n_chunks?

How many chunks to display when we translate from DNA to AA.

#

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/bioroebe/configuration/configuration.rb', line 59

def self.n_chunks?
  30
end

.use_expand_cd_aliases? ⇒ Boolean

#

Bioroebe::Configuration.use_expand_cd_aliases?

Query whether we will use class Rcfiles::DirectoryAliases or whether we will not. Boolean value.

#

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/bioroebe/configuration/configuration.rb', line 50

def self.use_expand_cd_aliases?
  @use_expand_cd_aliases
end

.use_opn?(use_this_file = "#{CONFIGURATION_DIRECTORY}use_opn.yml") ⇒ Boolean

#

Bioroebe.use_opn?

Query method to determine whether we will make use of Opn.opn() or whether we will not. By default we will, but the user can overrule this via a .yml configuration file.

#

Returns:

  • (Boolean) 


80
81
82
83
84
85
86
87
88
 
# File 'lib/bioroebe/configuration/configuration.rb', line 80

def self.use_opn?(
    use_this_file = "#{CONFIGURATION_DIRECTORY}use_opn.yml"
  )
  if File.exist? use_this_file
    YAML.load_file(use_this_file)
  else
    true # This is the default value in that case.
  end
end