Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-2377

Investigate odd text in DeepTools documentation text

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None
    • Story Points:
      0.5
    • Sprint:
      Spring 8 : 24 Apr to 8 May, Spring 8 : 11 May to 25 May, Spring 9 : 25 May to 8 Jun

      Description

      BioViz Connect has a feature that lets users run analysis algorithms on files using CyVerse cloud resources. This is super useful because often people want to see output of visual analytics functions that are too compute or data intensive to run on a personal computer.

      So we (IGB CyVerse core team) have created and published analysis "apps" within CyVerse itself, thus making them available for users to run and then view the output in IGB.

      Recently we published an App for generating scaled coverage graphs. This uses a tool from the DeepTools suite.

      Currently, the documentation for the App within BioViz Connect contains a weird-looking string - %INPUT%bam. (Please see attached screen capture.) It is not clear what this means and so this could be a bit confusing for users.

      For this task, investigate why this is being shown. If feasible, propose a way to remove it, unless it is trying to convey some kind of useful information, in which case we should probably try to think of better wording.

      Note: We might leave it – depends on the level of difficulty involved! Thus the goal of this task is to "investigate" only.

        Attachments

          Activity

          ann.loraine Ann Loraine created issue -
          ann.loraine Ann Loraine made changes -
          Field Original Value New Value
          Epic Link IGBF-2376 [ 18533 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          ann.loraine Ann Loraine made changes -
          Assignee Ann Loraine [ aloraine ]
          Hide
          ann.loraine Ann Loraine added a comment -

          cc: Nowlan Freese to keep you in the loop.

          Show
          ann.loraine Ann Loraine added a comment - cc: Nowlan Freese to keep you in the loop.
          ann.loraine Ann Loraine made changes -
          Description BioViz Connect has a feature that lets users run analysis algorithms on files using CyVerse cloud resources. This is super useful because often people want to see output of visual analytics functions that are too compute or data intensive to run on a personal computer.

          So we (IGB CyVerse core team) have created and published analysis "apps" within CyVerse itself, thus making them available for users to run and then view the output in IGB.

          Recently we published an App for generating scaled coverage graphs. This uses a tool from the DeepTools suite.

          Currently, the documentation for the App within BioViz Connect contains a weird-looking string - %INPUT%bam. (Please see attached screen capture.) It is not clear what this means and so this could be a bit confusing for users.

          For this task, investigate why this is being shown. If feasible, propose a way to remove it, unless it is trying to convey some kind of useful information, in which case we should probably try to think of better wording.
          BioViz Connect has a feature that lets users run analysis algorithms on files using CyVerse cloud resources. This is super useful because often people want to see output of visual analytics functions that are too compute or data intensive to run on a personal computer.

          So we (IGB CyVerse core team) have created and published analysis "apps" within CyVerse itself, thus making them available for users to run and then view the output in IGB.

          Recently we published an App for generating scaled coverage graphs. This uses a tool from the DeepTools suite.

          Currently, the documentation for the App within BioViz Connect contains a weird-looking string - %INPUT%bam. (Please see attached screen capture.) It is not clear what this means and so this could be a bit confusing for users.

          For this task, investigate why this is being shown. If feasible, propose a way to remove it, unless it is trying to convey some kind of useful information, in which case we should probably try to think of better wording.

          Note: We might leave it -- depends on the level of difficulty involved! Thus the goal of this task is to "investigate" only.
          ann.loraine Ann Loraine made changes -
          Sprint Spring 8 : 24 Apr to 8 May [ 93 ] Spring 8 : 24 Apr to 8 May, Spring 8 : 11 May to 25 May [ 93, 94 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          Hide
          nfreese Nowlan Freese added a comment -

          The %INPUT% is how BioViz Connect determines what input files an analysis can be run on. Unfortunately CyVerse does not provide additional fields that we can populate with this information.

          The only option to remove this so that the user does not see it would be to apply a filtering on BioViz Connect to remove any text starting with and following %INPUT% for the description field.

          I think it would be a good idea to filter out this information, as it is not beneficial to the user.

          Show
          nfreese Nowlan Freese added a comment - The %INPUT% is how BioViz Connect determines what input files an analysis can be run on. Unfortunately CyVerse does not provide additional fields that we can populate with this information. The only option to remove this so that the user does not see it would be to apply a filtering on BioViz Connect to remove any text starting with and following %INPUT% for the description field. I think it would be a good idea to filter out this information, as it is not beneficial to the user.
          ann.loraine Ann Loraine made changes -
          Sprint Spring 8 : 24 Apr to 8 May, Spring 8 : 11 May to 25 May [ 93, 94 ] Spring 8 : 24 Apr to 8 May, Spring 8 : 11 May to 25 May, Spring 9 : 25 May to 8 Jun [ 93, 94, 95 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          nfreese Nowlan Freese made changes -
          Assignee Chaitanya Kintali [ chaitanya ]
          chaitanya Chaitanya Kintali (Inactive) made changes -
          Status To-Do [ 10305 ] In Progress [ 3 ]
          Hide
          chaitanya Chaitanya Kintali (Inactive) added a comment -

          I have made the code changes to remove the %input% information from the description.
          However, it would not affect the current functionality or the flow, since, we are using the description from the Cyverse API to manage and show the list of apps at the backend, Doing any changes at the UI would not affect this flow.

          Moving it to Needs First Level Review.
          Nowlan Freese, Could you please test the above code changes at chaitanya.bioviz.org. I have my code changes pushed onto my ec2 and let me know if I can raise a pull request if everything looks good.

          https://bitbucket.org/ckintali/latest-ck-django-cyversedev/commits/9e152a6000e40211323d3f2f200bb7a55f660531
          https://bitbucket.org/ckintali/latest-ck-django-cyversedev/commits/bd23ea42549d1907a06df58063c05908d82a98bb

          Show
          chaitanya Chaitanya Kintali (Inactive) added a comment - I have made the code changes to remove the %input% information from the description. However, it would not affect the current functionality or the flow, since, we are using the description from the Cyverse API to manage and show the list of apps at the backend, Doing any changes at the UI would not affect this flow. Moving it to Needs First Level Review. Nowlan Freese , Could you please test the above code changes at chaitanya.bioviz.org. I have my code changes pushed onto my ec2 and let me know if I can raise a pull request if everything looks good. https://bitbucket.org/ckintali/latest-ck-django-cyversedev/commits/9e152a6000e40211323d3f2f200bb7a55f660531 https://bitbucket.org/ckintali/latest-ck-django-cyversedev/commits/bd23ea42549d1907a06df58063c05908d82a98bb
          chaitanya Chaitanya Kintali (Inactive) made changes -
          Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
          chaitanya Chaitanya Kintali (Inactive) made changes -
          Assignee Chaitanya Kintali [ chaitanya ] Nowlan Freese [ nfreese ]
          nfreese Nowlan Freese made changes -
          Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
          Hide
          nfreese Nowlan Freese added a comment -

          Working correctly for the three analyses, the %input% is not visible and the coverage graph analysis is still working.

          Moving to ready for pull request.

          Show
          nfreese Nowlan Freese added a comment - Working correctly for the three analyses, the %input% is not visible and the coverage graph analysis is still working. Moving to ready for pull request.
          nfreese Nowlan Freese made changes -
          Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
          nfreese Nowlan Freese made changes -
          Assignee Nowlan Freese [ nfreese ] Chaitanya Kintali [ chaitanya ]
          Hide
          nfreese Nowlan Freese added a comment -
          Show
          nfreese Nowlan Freese added a comment - Merged https://bitbucket.org/nfreese/django-cyversedev/pull-requests/165/igbf-2377/diff Chaitanya Kintali pull master onto your EC2 and I will test.
          nfreese Nowlan Freese made changes -
          Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
          nfreese Nowlan Freese made changes -
          Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
          nfreese Nowlan Freese made changes -
          Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
          nfreese Nowlan Freese made changes -
          Assignee Chaitanya Kintali [ chaitanya ]
          nfreese Nowlan Freese made changes -
          Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
          nfreese Nowlan Freese made changes -
          Assignee Nowlan Freese [ nfreese ]
          Hide
          nfreese Nowlan Freese added a comment -

          Working correctly.

          Closing issue.

          Show
          nfreese Nowlan Freese added a comment - Working correctly. Closing issue.
          nfreese Nowlan Freese made changes -
          Assignee Nowlan Freese [ nfreese ] Chaitanya Kintali [ chaitanya ]
          nfreese Nowlan Freese made changes -
          Resolution Done [ 10000 ]
          Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]

            People

            • Assignee:
              chaitanya Chaitanya Kintali (Inactive)
              Reporter:
              ann.loraine Ann Loraine
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: