JAL-2629 add multiple options for running hmmbuild on alignment/groups
[jalview.git] / src / jalview / hmmer / HMMBuildThread.java
index a9ca8ce..faba183 100644 (file)
@@ -3,6 +3,7 @@ package jalview.hmmer;
 
 import jalview.bin.Cache;
 import jalview.datamodel.AlignmentI;
+import jalview.datamodel.HiddenMarkovModel;
 import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceGroup;
 import jalview.datamodel.SequenceI;
@@ -11,15 +12,15 @@ import jalview.gui.AlignViewport;
 import jalview.gui.JvOptionPane;
 import jalview.gui.Preferences;
 import jalview.io.DataSourceType;
-import jalview.io.FileFormat;
-import jalview.io.FileLoader;
 import jalview.io.FileParse;
 import jalview.io.HMMFile;
 import jalview.util.MessageManager;
+import jalview.ws.params.ArgumentI;
 
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.List;
 
 import javax.swing.JOptionPane;
@@ -30,8 +31,10 @@ public class HMMBuildThread implements Runnable
   AlignFrame af;
 
   AlignViewport viewport;
+
   AlignmentI alignment;
   SequenceGroup group;
+  List<ArgumentI> params;
 
 
   boolean forGroup = false;
@@ -53,19 +56,16 @@ public class HMMBuildThread implements Runnable
     forGroup = false;
   }
 
-  public HMMBuildThread(AlignFrame af)
+  public HMMBuildThread(AlignFrame af, List<ArgumentI> args)
   {
     this.af = af;
-    if (af.getViewport().getSelectionGroup() != null)
-    {
-      group = af.getViewport().getSelectionGroup();
-      forGroup = true;
-    }
     viewport = af.getViewport();
-    alignment = viewport.getAlignment();
-
+    params = args;
   }
 
+  /**
+   * Builds a HMM from an alignment, then imports and adds it to the alignment.
+   */
   @Override
   public void run()
   {
@@ -76,113 +76,196 @@ public class HMMBuildThread implements Runnable
             barID);
     }
     cmds.HMMERFOLDER = Cache.getProperty(Preferences.HMMER_PATH);
-    if (alignment == null && group == null)
+
+    List<SequenceGroup> groups = new ArrayList<>();
+    if (params != null)
     {
-      JOptionPane.showMessageDialog(af,
-              MessageManager.getString("warn.no_sequence_data"));
-      return;
+      for (ArgumentI arg : params)
+      {
+        String name = arg.getName();
+        if (MessageManager.getString("label.hmmbuild_for").equals(name))
+        {
+          String value = arg.getValue();
+          if ("Alignment".equals(value))
+          {
+            alignment = viewport.getAlignment();
+            break;
+          }
+          else if ("All groups and alignment".equals(value))
+          {
+            alignment = viewport.getAlignment();
+            groups.addAll(viewport.getAlignment().getGroups());
+            break;
+          }
+          else if ("All groups".equals(value))
+          {
+            alignment = null;
+            groups = viewport.getAlignment().getGroups();
+            break;
+          }
+          else if ("Selected group".equals(value))
+          {
+            alignment = null;
+            groups.add(viewport.getSelectionGroup());
+            break;
+          }
+        }
+        else if (MessageManager.getString("label.use_reference")
+                .equals(name))
+        {
+          if (!af.getViewport().hasReferenceAnnotation())
+          {
+            if (af != null)
+            {
+              af.setProgressBar(
+                      MessageManager.getString("status.running_hmmbuild"),
+                      barID);
+            }
+            JvOptionPane.showInternalMessageDialog(af, MessageManager
+                    .getString("warn.no_reference_annotation"));
+            return;
+          }
+        }
+      }
     }
-    try
+
+    if (alignment != null)
     {
-      hmmTemp = File.createTempFile("hmm", ".hmm");
-      hmmTemp.deleteOnExit();
-      stoTemp = File.createTempFile("output", ".sto");
-      stoTemp.deleteOnExit();
-    } catch (IOException e1)
+      forGroup = false;
+      runHMMBuild();
+    }
+
+    if (alignment == null)
     {
-      e1.printStackTrace();
+      alignment = viewport.getAlignment();
     }
 
-    try
+    if (groups != null && groups.size() > 0)
     {
+      for (SequenceGroup grp : groups)
+      {
+        group = grp;
+        forGroup = true;
+        runHMMBuild();
+      }
+    }
+
+
+    if (af != null)
+    {
+      af.setProgressBar(MessageManager.getString("status.running_hmmbuild"),
+              barID);
+    }
+  }
+
+  private void runHMMBuild()
+  {
+    if (alignment == null && group == null)
+      {
+        JOptionPane.showMessageDialog(af,
+              MessageManager.getString("warn.no_sequence_data"));
+      }
+      try
+      {
+        hmmTemp = File.createTempFile("hmm", ".hmm");
+        hmmTemp.deleteOnExit();
+        stoTemp = File.createTempFile("output", ".sto");
+        stoTemp.deleteOnExit();
+      } catch (IOException e1)
+      {
+        e1.printStackTrace();
+      }
+
     try
     {
+      try
+      {
         SequenceI[] array;
-        List<SequenceI> seqs = alignment
-                .getHMMConsensusSequences(true);
-        cmds.setHmmSeqs(seqs);
+        List<SequenceI> seqs = null;
         if (forGroup)
         {
+          seqs = group.getHMMConsensusSequences(true);
+          if (seqs.size() > 0)
+          {
+            return;
+          }
           array = group.getSelectionAsNewSequences(alignment);
         }
         else
         {
+          seqs = alignment.getHMMConsensusSequences(true);
           if (!alignment.isAligned())
           {
             alignment.padGaps();
           }
           array = alignment.getSequencesArray();
         }
+
+          cmds.setHmmSeqs(seqs);
+
         if (array.length < 1)
-        {
+          {
           if (af != null)
           {
             JOptionPane.showMessageDialog(af,
-                  MessageManager.getString("warn.no_sequence_data"));
+                    MessageManager.getString("warn.no_sequence_data"));
           }
           return;
-        }
-        SequenceI[] newArr = new SequenceI[array.length];
-        int index = 0;
-        for (SequenceI seq : array)
-        {
-          newArr[index] = new Sequence(seq);
-          index++;
-        }
+          }
+          SequenceI[] newArr = new SequenceI[array.length];
+          int index = 0;
+          for (SequenceI seq : array)
+          {
+            newArr[index] = new Sequence(seq);
+            index++;
+          }
 
-        cmds.uniquifySequences(newArr);
-        cmds.exportData(newArr, stoTemp, null, null);
-        jalview.analysis.SeqsetUtils.deuniquify(cmds.hash, array);
+          cmds.uniquifySequences(newArr);
+          cmds.exportData(newArr, stoTemp, null, null);
+          jalview.analysis.SeqsetUtils.deuniquify(cmds.hash, array);
 
-    } catch (FileNotFoundException e)
-    {
-      // TODO Auto-generated catch block
-      e.printStackTrace();
+      } catch (FileNotFoundException e)
+      {
+        // TODO Auto-generated catch block
+        e.printStackTrace();
 
-    }
-    try
-    {
-        boolean ran = runCommand();
-        if (!ran)
-        {
-          if (af != null)
+      }
+      try
+      {
+          boolean ran = runCommand();
+          if (!ran)
           {
-            JvOptionPane.showInternalMessageDialog(af,
-                  MessageManager.getString("warn.hmmbuild_failed"));
+            return;
           }
-          return;
-        }
-    } catch (IOException | InterruptedException e)
-    {
-      // TODO Auto-generated catch block
-      e.printStackTrace();
-    }
-    try
-    {
+      } catch (IOException | InterruptedException e)
+      {
+        // TODO Auto-generated catch block
+        e.printStackTrace();
+      }
+      try
+      {
 
-      importData();
-    } catch (IOException | InterruptedException e)
-    {
-      // TODO Auto-generated catch block
-      e.printStackTrace();
-    }
-    } catch (Exception e)
-    {
-      e.printStackTrace();
-    } finally
-    {
-      if (af != null)
+        importData();
+      } catch (IOException | InterruptedException e)
       {
-        af.setProgressBar(
-                MessageManager.getString("status.running_hmmbuild"),
-              barID);
+        // TODO Auto-generated catch block
+        e.printStackTrace();
       }
+      } catch (Exception e)
+      {
+        e.printStackTrace();
     }
   }
 
   
 
-  
+  /**
+   * Executes the hmmbuild command in the command line.
+   * 
+   * @return
+   * @throws IOException
+   * @throws InterruptedException
+   */
   private boolean runCommand() throws IOException, InterruptedException
   {
     File file = new File(cmds.HMMERFOLDER + "/hmmbuild");
@@ -192,29 +275,59 @@ public class HMMBuildThread implements Runnable
       {
         if (!file.canExecute())
         {
+          if (af != null)
+          {
+            JvOptionPane.showInternalMessageDialog(af,
+                    MessageManager.getString("warn.hmmbuild_failed"));
+          }
           return false;
         }
       }
     }
-    String command = cmds.HMMERFOLDER + cmds.HMMBUILD + cmds.NAME;
-    if (forGroup)
+    String command = cmds.HMMERFOLDER + cmds.HMMBUILD + cmds.SPACE;
+    String name = null;
+
+    if (params != null)
     {
-      command += group.getName();
+      for (ArgumentI arg : params)
+      {
+        String argName = arg.getName();
+        switch (argName)
+        {
+        case "HMM Name":
+          name = arg.getValue();
+          break;
+        case "Use Reference Annotation":
+          command += "--hand ";
+          break;
+
+        }
+
+      }
     }
-    else
+
+    name = name.trim();
+
+    if (name == null || "".equals(name))
     {
-      String name = null;
-      if (af != null)
+      if (forGroup)
       {
-        name = af.getName();
+        name = group.getName();
       }
-      if (name == null)
+      else
       {
-        name = "Alignment";
+        if (af != null)
+        {
+          name = af.getTitle();
+        }
+        if (name == null || "".equals(name))
+        {
+          name = "Alignment";
+        }
       }
-      command += name;
     }
-    command += cmds.SPACE;
+
+    command += "-n " + name + cmds.SPACE;
     if (!alignment.isNucleotide())
     {
       command += cmds.FORCEAMINO; // TODO check for rna
@@ -229,27 +342,52 @@ public class HMMBuildThread implements Runnable
     return cmds.runCommand(command);
   }
   
+  /**
+   * Imports the .hmm file produced by hmmbuild.
+   * 
+   * @throws IOException
+   * @throws InterruptedException
+   */
   private void importData() throws IOException, InterruptedException
   {
-    if (af != null)
+      HMMFile file = new HMMFile(new FileParse(hmmTemp.getAbsolutePath(),
+              DataSourceType.FILE));
+    SequenceI[] seqs = file.getSeqsAsArray();
+    SequenceI seq = seqs[0];
+    seq.createDatasetSequence();
+    HiddenMarkovModel hmm = file.getHMM();
+    if (group != null)
     {
-      cmds.addHMMConsensusSequences(af);
-
-      FileLoader loader = new FileLoader();
-      loader.LoadFileOntoAlignmentWaitTillLoaded(viewport,
-              hmmTemp.getAbsolutePath(), DataSourceType.FILE,
-              FileFormat.HMMER3);
+      seq.insertCharAt(0, group.getStartRes(), '-');
+      seq.insertCharAt(group.getEndRes() + 1,
+              alignment.getWidth() - group.getEndRes(), '-');
+      seq.updateHMMMapping();
+      SequenceI topSeq = group.getSequencesInOrder(alignment)[0];
+      int topIndex = alignment.findIndex(topSeq);
+      alignment.insertSequenceAt(topIndex, seq);
+      group.setSeqrep(seq);
+      group.addSequence(seq, false);
     }
     else
     {
-      HMMFile file = new HMMFile(new FileParse(hmmTemp.getAbsolutePath(),
-              DataSourceType.FILE));
-      alignment.addSequence(file.getSeqsAsArray()[0]);
+      alignment.insertSequenceAt(0, seq);
+    }
+
+    viewport.alignmentChanged(viewport.getAlignPanel());
+    viewport.getAlignPanel().adjustAnnotationHeight();
+    viewport.updateSequenceIdColours();
+
+    if (viewport.getAlignPanel().alignFrame.getSelectedHMM() == null)
+    {
+      viewport.getAlignPanel().alignFrame.setSelectedHMMSequence(seq);
     }
     hmmTemp.delete();
     stoTemp.delete();
   }
   
+  /**
+   * Runs hmmbuild, and waits for the results to be imported before continuing
+   */
   public void hmmbuildWaitTillComplete()
   {
     Thread loader = new Thread(this);