Uploaded image for project: 'UGENE'
  1. UGENE
  2. UGENE-6095

Dialog for configuring Trimmomatic steps: general and ILLUMINACLIP (without optional settings)

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Blocker
    • Resolution: Fixed
    • Affects Version/s: virogenesis
    • Fix Version/s: 1.31
    • Component/s: NGS, Workflow
    • Labels:
      None
    • Story Points:
      1
    • Epic Link:
    • Sprint:
      DEV-31-1, DEV-31-2
    • Affect Type:
      Userdefined

      Description

      Implement a dialog opened when a user clicks the browse button ("...") for "Trimming steps" parameters of the Trimmomatic element (see UGENE-6094).

      Dialog appearance

      1. The dialog title should be "Configure Trimmomatic Steps".
      2. Use dialog from "trimmomatic_dialog_illuminaclip.zip" for the initial layout.
      3. Add/improve layout of the widgets.
      4. Make the "Steps" widget read-only.
      5. Optionally, modify font of the "Step settings" group title.
      6. Modify layout of "Apply", "Cancel" and "Help" button as in other UGENE dialogs (if required).
      7. Add hints (at least for buttons: "Add step", "Remove step", "Perform step earlier", "Perform step later").
      8. Replace line edit widgets in the "ILLUMINACLIP" settings by other widgets, if required.
      9. Etc.

      General behavior

      1. The default layout is when no steps are added (see "default_nothing_added.png").
      2. When the "Add step" button is clicked (see "ILLUMINACLIP_step_added.png"):
        • Add the "ILLUMINACLIP" value to the "Steps" text box. The value should be selected.
        • Change layout in the "Step settings" group.
        • Change description in the "Description" field. Both descriptions can be found in "descriptions_general_and _illuminaclip_step.zip".
      3. When "Remove step" is clicked, restore the default appearance.
      4. For now do not add implement (this will be done in UGENE-6096):
        • Handling of up and down arrow buttons.
        • Disabling of the buttons near the "Steps" widget.

      ILLUMINACLIP settings

      1. Use the following possible and default values for the settings:
        • Adapter sequences: a file in FASTA format is required as input. By default, use files from
          the "data/adapters/illumina" folder (see UGENE-6092). Use ""TruSeq3-SE.fa", if the element's parameter "Input data" is set to "SE reads". Use "TruSeq3-PE-2.fa", if the value is "PE reads".
        • Seed mismatches: the value must be >= 0. By default, set it to 2.
          Note: In theory, the value should be small, at least it should be less than a read length. However, Trimmomatic does not do validation of input parameters, so let's skip this for now as well.)
        • Palindrome clip threshold: use 30 by default. For now, make the possible value > 0.
        • Simple clip threshold: use 10 by default. For now, make the possible value > 0.
      2. Do not implement opening of an additional dialog on the "Options" button click. This will be done in terms of UGENE-6097.
      3. When one of the mandatory parameter is not set:
        • Highlight its background with the standard pink color, used in UGENE.
        • Disable the "Apply" button.
          Restore the previous state, if settings are correct.

      Appearance in the Property Editor

      In the Property Editor values, set up in the dialog should look like a non editable text field with part of the command that will be passed to the Trimmomatic executable, e.g. "ILLUMINACLIP:TruSeq3-SE:2:30:10". The browse button nearby the text field should open the dialog. The default value of the text field is "Configure steps" as it is written in UGENE-6094.

      Appearance in a wizard

      Adding of the "Trimming steps" parameter into a wizard should look like in the Property Editor that is a non editable text field with the possibility to open the "Configure Trimmomatic Steps" dialog.

      Parameter value in a UWL file

      The parameter value should be stored as a string.
      Note: It means, an invalid value may be specified and passed to Trimmomatic. However, let's skip the string validation for now.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              dsukhomlinov Dmitrii Sukhomlinov
              Reporter:
              oigl Olga Golosova
              Assigned Tester:
              Svetlana Samoilenko
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: