Class: Bioroebe::DownloadTaxonomyDatabase

Inherits:
CommandlineApplication show all
Defined in:
lib/bioroebe/databases/download_taxonomy_database.rb

Overview

Bioroebe::DownloadTaxonomyDatabase

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, #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(url = FTP_NCBI_TAXONOMY_DATABASE, run_already = true) ⇒ DownloadTaxonomyDatabase

#

initialize

#

22
23
24
25
26
27
28
29
 
# File 'lib/bioroebe/databases/download_taxonomy_database.rb', line 22

def initialize(
    url         = FTP_NCBI_TAXONOMY_DATABASE,
    run_already = true
  )
  reset
  set_url(url)
  run if run_already
end

Instance Method Details

#determine_download_location ⇒ Object

#

determine_download_location

Determine the instance variable @download_location here.

#

50
51
52
53
 
# File 'lib/bioroebe/databases/download_taxonomy_database.rb', line 50

def determine_download_location
  @download_location = taxonomy_download_directory?+
                       File.basename(@url)
end

#download_location? ⇒ Boolean

#

download_location?

#

Returns:

  • (Boolean) 

58
59
60
 
# File 'lib/bioroebe/databases/download_taxonomy_database.rb', line 58

def download_location? # We will store the file here.
  @download_location
end

#report_that_we_have_finished_the_download ⇒ Object

#

report_that_we_have_finished_the_download

#

65
66
67
 
# File 'lib/bioroebe/databases/download_taxonomy_database.rb', line 65

def report_that_we_have_finished_the_download
  e "Finished downloading into `#{sdir(@download_location)}`."
end

#reset ⇒ Object

#

reset

#

34
35
36
 
# File 'lib/bioroebe/databases/download_taxonomy_database.rb', line 34

def reset
  super()
end

#run ⇒ Object

#

run

#

72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/bioroebe/databases/download_taxonomy_database.rb', line 72

def run
  determine_download_location
  this_dir = taxonomy_download_directory?
  unless File.directory? this_dir
    mkdir(this_dir) { :be_quiet }
    cd this_dir
  end
  erev 'Downloading into `'+sdir(this_dir)+rev+'` next.'
  esystem "wget #{@url}"
  report_that_we_have_finished_the_download if be_verbose?
  if is_on_roebe? # Extract it at once on my home system.
    extract(File.basename(@url))
  end
end

#set_url(i) ⇒ Object

#

set_url

#

41
42
43
 
# File 'lib/bioroebe/databases/download_taxonomy_database.rb', line 41

def set_url(i)
  @url = i
end