miga-base 0.7.23.0 → 0.7.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ed8981c0dfc266aea53be66e06b77eaf277444a094ef460021c2713aef3bf73
-  data.tar.gz: d9f0bd3934dd5e3ba27cb58adfd1236a74ba6b003a06cd74b9da96e594a27e99
+  metadata.gz: 82ca84b468df712ab38eba74071c26e8dcb1d87335764dde2ba86075abc8c8d5
+  data.tar.gz: 36583e298fc020faa5cc16af2f6a3fcc88c30619a4f529fd6f03772f6c437bb9
 SHA512:
-  metadata.gz: f40242b96f36ce5528e2206aa4f366d047b5969a45d69cff5ac825297563f9adddaee957e562eddae34c96b8a0651fd2fec39a42d2cd278d66ea03ac35afabfc
-  data.tar.gz: ab01b09ab020c1bfcf5dd5be7a01c971e83e02066ad35f4b6a9f0c525351c81b5cdb0e80910cf4237b9e59a33c518995a073c1f625f049b6b722802541d11c1f
+  metadata.gz: d78a3709fecba4594d8dc9a2351f217b3605022237e424eb1a194ccf62ddf2059eb1df274f68a15cda74936dfece3f2123485483773172cc62cfba9ff454c5d2
+  data.tar.gz: fbf11b04c062701b204f4ba93425dea6f8ff1492fe48f7182472e65b16fccbde98e86d396a79cf51c6e410a246c3b9e9509043eaf952b320191ec086e2efa573

data/Gemfile

@@ -1,6 +1,9 @@
 source "https://rubygems.org"
 gemspec name: "miga-base"
+
 group :test do
   gem "simplecov"
   gem "codeclimate-test-reporter", "~> 1.0.0"
 end
+
+gem "rake", "~> 12.0"

data/Rakefile

@@ -1,3 +1,4 @@
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 SOURCES = FileList['lib/**/*.rb']

data/lib/miga/cli/action/add.rb

@@ -65,8 +65,7 @@ class MiGA::Cli::Action::Add < MiGA::Cli::Action
       next if d.nil?
 
       copy_file_to_project(file, file_type, d, p)
-      d = cli.add_metadata(d)
-      d.save
+      cli.add_metadata(d)
       p.add_dataset(d.name)
       res = d.first_preprocessing(true)
       cli.say "  result: #{res}"

data/lib/miga/cli/action/classify_wf.rb

@@ -49,23 +49,24 @@ class MiGA::Cli::Action::ClassifyWf < MiGA::Cli::Action
   def perform
     # Input data
     ref_db = reference_db
-    p_metadata = Hash[
-      %w[project_stats haai_distances aai_distances ani_distances clade_finding]
-                 .map { |i| ["run_#{i}", false] }
+    norun = %w[
+      project_stats haai_distances aai_distances ani_distances clade_finding
     ]
-    p_metadata[:ref_project] = ref_db.path
-    p_metadata[:tax_pvalue] = cli[:pvalue]
-    p = create_project(:assembly, p_metadata,
-                       run_ssu: false, run_mytaxa_scan: false, run_distances: false)
+    p_metadata = Hash[norun.map { |i| ["run_#{i}", false] }]
+    p = create_project(
+      :assembly,
+      p_metadata,
+      run_ssu: false, run_mytaxa_scan: false, run_distances: false
+    )
+    p.set_option(:ref_project, ref_db.path)
+    p.set_option(:tax_pvalue, cli[:pvalue], true)
     # Run
     run_daemon
     summarize(%w[cds assembly essential_genes]) if cli[:summaries]
     summarize(['taxonomy'])
     cli.say "Summary: classification"
-    call_cli([
-               'ls', '-P', cli[:outdir], '-m', 'tax', '--tab',
-               '-o', File.expand_path('classification.tsv', cli[:outdir])
-             ])
+    ofile = File.expand_path('classification.tsv', cli[:outdir])
+    call_cli(['ls', '-P', cli[:outdir], '-m', 'tax', '--tab', '-o', ofile])
     cleanup
   end
 

data/lib/miga/cli/action/derep_wf.rb

@@ -52,17 +52,11 @@ class MiGA::Cli::Action::DerepWf < MiGA::Cli::Action
     # Input data
     p = create_project(
       :assembly,
-      {
-        run_project_stats: false,
-        run_clades: false,
-        gsp_metric: cli[:metric],
-        :"gsp_#{cli[:metric]}" => cli[:threshold]
-      },
+      { run_project_stats: false, run_clades: false },
       { run_mytaxa_scan: false, run_ssu: false }
     )
-    unless cli[:threshold] >= 0.0 && cli[:threshold] <= 100.0
-      raise 'The threshold of identity must be in the range [0,100]'
-    end
+    p.set_option(:gsp_metric, cli[:metric])
+    p.set_option(:"gsp_#{cli[:metric]}", cli[:threshold])
 
     # Run
     run_daemon

data/lib/miga/cli/action/edit.rb

@@ -34,6 +34,5 @@ class MiGA::Cli::Action::Edit < MiGA::Cli::Action
       cli[:activate] ? obj.activate! : obj.inactivate!(cli[:reason])
     end
     cli.add_metadata(obj)
-    obj.save
   end
 end

data/lib/miga/cli/action/find.rb

@@ -37,7 +37,7 @@ class MiGA::Cli::Action::Find < MiGA::Cli::Action
       if cli[:add]
         cli.say "Registering: #{dn}"
         d = Dataset.new(p, dn, cli[:ref])
-        d = add_metadata(d)
+        add_metadata(d)
         p.add_dataset(dn)
         res = d.first_preprocessing(true)
         cli.say "- #{res}"

data/lib/miga/cli/action/generic.rb

@@ -20,7 +20,7 @@ class MiGA::Cli::Action::Generic < MiGA::Cli::Action
       opt.on(
         '-v', '--version',
         'Show MiGA version'
-      ) { puts MiGA::MiGA.VERSION; exit }
+      ) { puts MiGA::MiGA.FULL_VERSION; exit }
       opt.on(
         '-V', '--long-version',
         'Show complete MiGA version'

data/lib/miga/cli/action/get.rb

@@ -6,8 +6,9 @@ require 'miga/remote_dataset'
 
 class MiGA::Cli::Action::Get < MiGA::Cli::Action
   def parse_cli
-    cli.defaults = { query: false, universe: :ncbi, db: :nuccore,
-                     get_md: false, only_md: false }
+    cli.defaults = {
+      query: false, universe: :ncbi, db: :nuccore, get_md: false, only_md: false
+    }
     cli.parse do |opt|
       cli.opt_object(opt, [:project, :dataset, :dataset_type])
       opt.on(
@@ -141,6 +142,10 @@ class MiGA::Cli::Action::Get < MiGA::Cli::Action
 
   def create_dataset(sub_cli, p, rd)
     sub_cli.say 'Creating dataset'
+    if Dataset.exist?(p, sub_cli[:dataset])
+      raise "Dataset already exists: #{sub_cli[:dataset]}"
+    end
+
     dummy_d = Dataset.new(p, sub_cli[:dataset])
     md = sub_cli.add_metadata(dummy_d).metadata.data
     md[:metadata_only] = true if cli[:only_md]

data/lib/miga/cli/action/ncbi_get.rb

@@ -269,7 +269,7 @@ class MiGA::Cli::Action::NcbiGet < MiGA::Cli::Action
     else
       cli.say '  Creating dataset'
       rd.save_to(p, name, !cli[:query], body[:md])
-      cli.add_metadata(p.add_dataset(name)).save
+      cli.add_metadata(p.add_dataset(name))
     end
   end
 end

data/lib/miga/cli/action/new.rb

@@ -24,6 +24,11 @@ class MiGA::Cli::Action::New < MiGA::Cli::Action
         'Use faster identity engines (Diamond-AAI and FastANI)',
         'Equivalent to: -m aai_p=diamond,ani_p=fastani'
       ) { |v| cli[:fast] = v }
+      opt.on(
+        '--sensitive',
+        'Use more sensitive identity engines (BLAST+)',
+        'Equivalent to: -m aai_p=blast+,ani_p=blast+'
+      ) { |v| cli[:sensitive] = v }
       opt.on(
         '-m', '--metadata STRING',
         'Metadata as key-value pairs separated by = and delimited by comma',
@@ -35,20 +40,21 @@ class MiGA::Cli::Action::New < MiGA::Cli::Action
   def perform
     cli.ensure_type(MiGA::Project)
     cli.ensure_par(project: '-P')
-    unless File.exist?(File.join(ENV['HOME'], '.miga_rc')) &&
-           File.exist?(File.join(ENV['HOME'], '.miga_daemon.json'))
-      raise "You must initialize MiGA before creating the first project.\n" +
-            'Please use "miga init".'
+    unless MiGA::MiGA.initialized?
+      raise 'MiGA has not been initialized, please use "miga init" first'
     end
     cli.say "Creating project: #{cli[:project]}"
-    raise 'Project already exists, aborting.' if Project.exist? cli[:project]
+    raise 'Project already exists, aborting' if Project.exist?(cli[:project])
 
     p = Project.new(cli[:project], false)
     p = cli.add_metadata(p)
-    if cli[:fast]
-      p.metadata[:aai_p] = 'diamond'
-      p.metadata[:ani_p] = 'fastani'
+
+    if cli[:sensitive]
+      p.set_option(:aai_p, 'blast+')
+      p.set_option(:ani_p, 'blast+')
+    elsif cli[:fast]
+      p.set_option(:aai_p, 'diamond')
+      p.set_option(:ani_p, 'fastani')
     end
-    p.save
   end
 end

data/lib/miga/cli/action/option.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'miga/cli/action'
+
+##
+# CLI: `miga option`
+class MiGA::Cli::Action::Option < MiGA::Cli::Action
+  def parse_cli
+    cli.parse do |opt|
+      cli.opt_object(opt, %i[project dataset_opt])
+      opt.on(
+        '-k', '--key STRING',
+        'Option name to get or set (by default, all options are printed)'
+      ) { |v| cli[:key] = v }
+      opt.on(
+        '--value STRING',
+        'Value of the option to set (by default, option value is not changed)',
+        'Recognized tokens: nil, true, false'
+      ) { |v| cli[:value] = v }
+      opt.on(
+        '-o', '--output PATH',
+        'Create output file instead of returning to STDOUT'
+      ) { |v| cli[:output] = v }
+    end
+  end
+
+  def perform
+    unless cli[:value].nil?
+      cli.ensure_par(
+        { key: '-k' },
+        '%<name>s is mandatory when --value is set: please provide %<flag>s'
+      )
+    end
+    obj = cli.load_project_or_dataset
+    io = cli[:output].nil? ? $stdout : File.open(cli[:output], 'w')
+    if cli[:key].nil?
+      cli.table(%w[Key Value], obj.all_options.to_a, io)
+    else
+      obj.set_option(cli[:key], cli[:value], true) unless cli[:value].nil?
+      io.puts obj.option(cli[:key])
+    end
+    io.close unless cli[:output].nil?
+  end
+end

data/lib/miga/cli/action/quality_wf.rb

@@ -21,10 +21,10 @@ class MiGA::Cli::Action::QualityWf < MiGA::Cli::Action
 
   def perform
     # Input data
-    p_metadata = Hash[
-      %w[project_stats haai_distances aai_distances ani_distances clade_finding]
-                 .map { |i| ["run_#{i}", false] }
+    norun = %w[
+      project_stats haai_distances aai_distances ani_distances clade_finding
     ]
+    p_metadata = Hash[norun.map { |i| ["run_#{i}", false] }]
     d_metadata = { run_distances: false }
     d_metadata[:run_mytaxa_scan] = false unless cli[:mytaxa]
     p = create_project(:assembly, p_metadata, d_metadata)

data/lib/miga/cli/action/tax_dist.rb

@@ -47,7 +47,7 @@ class MiGA::Cli::Action::TaxDist < MiGA::Cli::Action
 
   def read_distances
     p = cli.load_project
-    cli[:metric] ||= p.is_clade? ? 'ani' : 'aai'
+    cli[:metric] ||= p.clade? ? 'ani' : 'aai'
     res_n = "#{cli[:metric]}_distances"
     cli.say "Reading distances: 1-#{cli[:metric].upcase}"
     res = p.result(res_n)

data/lib/miga/cli/action/tax_test.rb

@@ -59,7 +59,7 @@ class MiGA::Cli::Action::TaxTest < MiGA::Cli::Action
     cli.puts "Closest relative: #{cr[0]} with AAI: #{cr[1]}."
     p = cli.load_project
     if cli[:ref_project]
-      if (ref = p.metadata[:ref_project]).nil?
+      if (ref = p.option(:ref_project)).nil?
         raise '--ref-project requested but no reference project has been set'
       end
       if (q = MiGA::Project.load(ref)).nil?

data/lib/miga/cli/action/wf.rb

@@ -9,7 +9,7 @@ module MiGA::Cli::Action::Wf
     cli.defaults = {
       clean: false, regexp: MiGA::Cli.FILE_REGEXP,
       project_type: :genomes, dataset_type: :popgenome,
-      ncbi_draft: true, min_qual: 25.0
+      ncbi_draft: true, min_qual: MiGA::Project.OPTIONS[:min_qual][:default]
     }
   end
 
@@ -125,32 +125,34 @@ module MiGA::Cli::Action::Wf
       dataset_type: '--dataset-type'
     )
     # Create empty project
-    call_cli([
-               'new',
-               '-P', cli[:outdir],
-               '-t', cli[:project_type]
-             ]) unless MiGA::Project.exist? cli[:outdir]
+    call_cli(
+      ['new', '-P', cli[:outdir], '-t', cli[:project_type]]
+    ) unless MiGA::Project.exist? cli[:outdir]
     # Define project metadata
     p = cli.load_project(:outdir, '-o')
-    %i[haai_p aai_p ani_p ess_coll min_qual].each { |i| p_metadata[i] = cli[i] }
     p_metadata[:type] = cli[:project_type]
     transfer_metadata(p, p_metadata)
+    %i[haai_p aai_p ani_p ess_coll min_qual].each do |i|
+      p.set_option(i, cli[i])
+    end
     # Download datasets
-    call_cli([
-               'ncbi_get',
-               '-P', cli[:outdir],
-               '-T', cli[:ncbi_taxon],
-               (cli[:ncbi_draft] ? '--all' : '--complete')
-             ]) unless cli[:ncbi_taxon].nil?
+    unless cli[:ncbi_taxon].nil?
+      what = cli[:ncbi_draft] ? '--all' : '--complete'
+      call_cli(
+        ['ncbi_get', '-P', cli[:outdir], '-T', cli[:ncbi_taxon], what]
+      )
+    end
     # Add datasets
-    call_cli([
-      'add',
-      '--ignore-dups',
-      '-P', cli[:outdir],
-      '-t', cli[:dataset_type],
-      '-i', stage,
-      '-R', cli[:regexp]
-    ] + cli.files) unless cli.files.empty?
+    call_cli(
+      [
+        'add',
+        '--ignore-dups',
+        '-P', cli[:outdir],
+        '-t', cli[:dataset_type],
+        '-i', stage,
+        '-R', cli[:regexp]
+      ] + cli.files
+    ) unless cli.files.empty?
     # Define datasets metadata
     p.load
     d_metadata[:type] = cli[:dataset_type]
@@ -161,13 +163,13 @@ module MiGA::Cli::Action::Wf
   def summarize(which = %w[cds assembly essential_genes ssu])
     which.each do |r|
       cli.say "Summary: #{r}"
-      call_cli([
-                 'summary',
-                 '-P', cli[:outdir],
-                 '-r', r,
-                 '-o', File.expand_path("#{r}.tsv", cli[:outdir]),
-                 '--tab', '--ref', '--active'
-               ])
+      call_cli(
+        [
+          'summary',
+          '-P', cli[:outdir], '-r', r, '--tab', '--ref', '--active',
+          '-o', File.join(cli[:outdir], "#{r}.tsv")
+        ]
+      )
     end
     call_cli(['browse', '-P', cli[:outdir]])
   end
@@ -193,14 +195,14 @@ module MiGA::Cli::Action::Wf
     cmd += ['--max-jobs', cli[:jobs]] unless cli[:jobs].nil?
     cmd += ['--ppn', cli[:threads]] unless cli[:threads].nil?
     cwd = Dir.pwd
-    call_cli cmd
+    call_cli(cmd)
     Dir.chdir(cwd)
   end
 
   def transfer_metadata(obj, md)
     # Clear old metadata
     obj.metadata.each do |k, v|
-      obj.metadata[k] = nil if k.to_s =~ /^run_/ || k == :ref_project
+      obj.metadata[k] = nil if k.to_s =~ /^run_/ || obj.option?(k)
     end
     # Transfer and save
     md.each { |k, v| obj.metadata[k] = v }

data/lib/miga/cli/base.rb

@@ -34,6 +34,7 @@ module MiGA::Cli::Base
     next_step: 'Return the next task to run in a dataset or project',
     # Objects (Datasets or Projects)
     edit: 'Edit the metadata of a dataset or project',
+    option: 'Get or set options of a dataset or project',
     # System
     init: 'Initialize MiGA to process new projects',
     daemon: 'Control the daemon of a MiGA project',

data/lib/miga/cli/objects_helper.rb

@@ -57,12 +57,12 @@ module MiGA::Cli::ObjectsHelper
     ds.select! do |d|
       advance('Datasets:', k += 1, n, false)
       o = true
-      o &&= (d.is_ref? == self[:ref]) unless self[:ref].nil?
-      o &&= (d.is_active? == self[:active]) unless self[:active].nil?
-      o &&= (self[:multi] ? d.is_multi? :
-            d.is_nonmulti?) unless self[:multi].nil?
-      o &&= (not d.metadata[:tax].nil?) &&
-            d.metadata[:tax].in?(self[:taxonomy]) unless self[:taxonomy].nil?
+      o &&= (d.ref? == self[:ref]) unless self[:ref].nil?
+      o &&= (d.active? == self[:active]) unless self[:active].nil?
+      o &&= (self[:multi] ? d.multi? : d.nonmulti?) unless self[:multi].nil?
+      unless self[:taxonomy].nil?
+        o &&= !d.metadata[:tax].nil? && d.metadata[:tax].in?(self[:taxonomy])
+      end
       o
     end
     say ''
@@ -90,22 +90,27 @@ module MiGA::Cli::ObjectsHelper
   def add_metadata(obj, cli = self)
     raise "Unsupported object: #{obj.class}" unless obj.respond_to? :metadata
 
-    cli[:metadata].split(',').each do |pair|
+    (cli[:metadata] || '').split(',').each do |pair|
       (k, v) = pair.split('=')
-      case v
-      when 'true';  v = true
-      when 'false'; v = false
-      when 'nil';   v = nil
-      end
-      if k == '_step'
-        obj.metadata["_try_#{v}"] ||= 0
-        obj.metadata["_try_#{v}"]  += 1
+      if obj.option?(k)
+        obj.set_option(k, v, true)
+      else
+        case v
+        when 'true';  v = true
+        when 'false'; v = false
+        when 'nil';   v = nil
+        end
+        if k == '_step'
+          obj.metadata["_try_#{v}"] ||= 0
+          obj.metadata["_try_#{v}"]  += 1
+        end
+        obj.metadata[k] = v
       end
-      obj.metadata[k] = v
-    end unless cli[:metadata].nil?
-    [:type, :name, :user, :description, :comments].each do |k|
+    end
+    %i[type name user description comments].each do |k|
       obj.metadata[k] = cli[k] unless cli[k].nil?
     end
+    obj.save
     obj
   end
 end