JAL-2629 add simple jackhmmer functionality

[jalview.git] / src / jalview / hmmer / HMMERParamStore.java

diff --git a/src/jalview/hmmer/HMMERParamStore.java b/src/jalview/hmmer/HMMERParamStore.java
index 00cae85..f95d738 100644 (file)
--- a/src/jalview/hmmer/HMMERParamStore.java
+++ b/src/jalview/hmmer/HMMERParamStore.java
@@ -10,9 +10,11 @@ import jalview.ws.params.ParamDatastoreI;
 import jalview.ws.params.WsParamSetI;
 import jalview.ws.params.simple.BooleanOption;
 import jalview.ws.params.simple.DoubleParameter;
+import jalview.ws.params.simple.FileParameter;
 import jalview.ws.params.simple.IntegerParameter;
 import jalview.ws.params.simple.LogarithmicParameter;
 import jalview.ws.params.simple.Option;
+import jalview.ws.params.simple.RadioChoiceParameter;
 import jalview.ws.params.simple.StringParameter;
 
 import java.io.File;
@@ -30,6 +32,8 @@ public final class HMMERParamStore implements ParamDatastoreI
 
   private static final String HMMSEARCH = "hmmsearch";
 
+  private static final String JACKHMMER = "jackhmmer";
+
   private String name;
 
   private List<WsParamSetI> presets = new ArrayList<>();
@@ -57,6 +61,11 @@ public final class HMMERParamStore implements ParamDatastoreI
     return new HMMERParamStore(HMMSEARCH, viewport);
   }
 
+  public static HMMERParamStore forJackhmmer(AlignmentViewport viewport)
+  {
+    return new HMMERParamStore(JACKHMMER, viewport);
+  }
+
   @Override
   public List<WsParamSetI> getPresets()
   {
@@ -84,6 +93,8 @@ public final class HMMERParamStore implements ParamDatastoreI
     case HMMBUILD:
       getHMMBuildParams(args);
       break;
+    case JACKHMMER:
+      getJackhmmerParams(args);
     default:
     }
 
@@ -104,7 +115,7 @@ public final class HMMERParamStore implements ParamDatastoreI
     args.add(new BooleanOption(
             MessageManager.getString(HMMSearch.AUTO_ALIGN_SEQS_KEY),
             MessageManager.getString("label.auto_align_seqs_desc"), false,
-            false, true, null));
+            false, false, null));
     args.add(new BooleanOption(
             MessageManager.getString(HMMSearch.USE_ACCESSIONS_KEY),
             MessageManager.getString("label.use_accessions_desc"), false,
@@ -119,18 +130,26 @@ public final class HMMERParamStore implements ParamDatastoreI
      */
     addChoiceOfHmm(args);
 
-    addChoiceOfDatabase(args);
-
+    // addChoiceOfDatabase(args);
+
+    String thisAlignment = MessageManager
+            .getString(HMMSearch.THIS_ALIGNMENT_KEY);
+    String database = MessageManager.getString("label.database");
+    args.add(new RadioChoiceParameter(
+            MessageManager.getString("action.search"), null,
+            Arrays.asList(thisAlignment,
+                    database),
+            thisAlignment));
+    args.add(new FileParameter(database, "", false, "", ""));
     args.add(new IntegerParameter(
             MessageManager.getString(HMMSearch.NUMBER_OF_RESULTS_KEY),
             MessageManager.getString("label.number_of_results_desc"), true,
             100, 0, 100000));
-    args.add(new StringParameter(
+    args.add(new RadioChoiceParameter(
             MessageManager.getString(HMMSearch.REPORTING_CUTOFF_KEY), null,
-            true, HMMSearch.CUTOFF_NONE, HMMSearch.CUTOFF_NONE,
             Arrays.asList(HMMSearch.CUTOFF_NONE, HMMSearch.CUTOFF_EVALUE,
                     HMMSearch.CUTOFF_SCORE),
-            null));
+            HMMSearch.CUTOFF_EVALUE));
     args.add(new LogarithmicParameter(
             MessageManager.getString(HMMSearch.SEQ_EVALUE_KEY),
             MessageManager.getString("label.seq_e_value_desc"), false, 1D,
@@ -152,6 +171,52 @@ public final class HMMERParamStore implements ParamDatastoreI
   }
 
   /**
+   * Answers default parameters for jackhmmer, taking into account any configured
+   * as user preferences
+   * 
+   * @param args
+   */
+  private void getJackhmmerParams(List<ArgumentI> args)
+  {
+
+    /*
+     * 'Parameters'
+     */
+    addChoiceOfSequence(args);
+
+    // addChoiceOfDatabase(args);
+
+    String thisAlignment = MessageManager
+            .getString(JackHMMER.THIS_ALIGNMENT_KEY);
+    String database = MessageManager.getString("label.database");
+    args.add(new RadioChoiceParameter(
+            MessageManager.getString("action.search"), null,
+            Arrays.asList(thisAlignment, database), thisAlignment));
+    args.add(new FileParameter(database, "", false, "", ""));
+    args.add(new RadioChoiceParameter(
+            MessageManager.getString(JackHMMER.REPORTING_CUTOFF_KEY), null,
+            Arrays.asList(JackHMMER.CUTOFF_NONE, JackHMMER.CUTOFF_EVALUE,
+                    JackHMMER.CUTOFF_SCORE),
+            JackHMMER.CUTOFF_EVALUE));
+    args.add(new LogarithmicParameter(
+            MessageManager.getString(JackHMMER.SEQ_EVALUE_KEY),
+            MessageManager.getString("label.seq_e_value_desc"), false, 1D,
+            1E-38, 10D));
+    args.add(new LogarithmicParameter(
+            MessageManager.getString(JackHMMER.DOM_EVALUE_KEY),
+            MessageManager.getString("label.dom_e_value_desc"), false, 1D,
+            1E-38, 10D));
+    args.add(new DoubleParameter(
+            MessageManager.getString(JackHMMER.SEQ_SCORE_KEY),
+            MessageManager.getString("label.seq_score_desc"), false, 0d, 0d,
+            1000d));
+    args.add(new DoubleParameter(
+            MessageManager.getString(JackHMMER.DOM_SCORE_KEY),
+            MessageManager.getString("label.dom_score_desc"), false, 0d, 0d,
+            1000d));
+  }
+
+  /**
    * Constructs a choice parameter for database to search; always includes 'this
    * alignment', and also includes any databases held under user preferences key
    * "HMMSEARCH_DBS" as a comma-delimited list
@@ -244,6 +309,31 @@ public final class HMMERParamStore implements ParamDatastoreI
   }
 
   /**
+   * Adds an argument representing the choice of sequence against which to perform
+   * jackhmmer
+   * 
+   * @param args
+   */
+  protected void addChoiceOfSequence(List<ArgumentI> args)
+  {
+    List<SequenceI> sequences = viewport.getAlignment().getSequences();
+
+    List<String> options = new ArrayList<>();
+
+    for (SequenceI seq : sequences)
+    {
+      options.add(seq.getName());
+    }
+
+    String defseq = options.get(0);
+    ArgumentI arg = new StringParameter(
+            MessageManager.getString("label.use_sequence"), null, true,
+            defseq,
+            defseq, options, null);
+    args.add(arg);
+  }
+
+  /**
    * Answers default parameters for hmmbuild, taking into account any configured
    * as user preferences
    *