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

Make a new IGB "demo" App that shows how Apps can get access to track data

    Details

    • Type: New Feature
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:
      None
    • Story Points:
      4
    • Sprint:
      Summer 2018 Part 2, Summer 2018 Part 3, Fall 2018 1, Summer 2019 Sprint 10, Summer 2019 Sprint 11, Summer 2019 Sprint 12, Fall 2019 Sprint 1, Fall 2019 Sprint 2, Fall 2019 Sprint 3

      Description

      A potential App developer asks:

      "can I extract from IGB values for selected/all loaded lines for selected genomic region? For example, I have two tracks for ChIP-seq against two different transcription factors and I want to know what is their average score for selected region e.q. 1kb or 10kb. Can I have also information about which genes (mRNA) are present in this region or values for any other line?"

      Investigate:

      • How does an App find out what tracks are loaded (or selected) in IGB?
      • How does an App access the loaded data for a region?

      Tip:

      • Look at how track filters and operators work.

      *EDIT*: Instead of documenting, let's create a demo App that shows how these things can be done. For spec, see June 2019 comments from Dr. Loraine.

        Attachments

          Issue Links

            Activity

            Hide
            ann.loraine Ann Loraine added a comment -

            To review:

            • Look at the code. Developer should be able to read the code and know (1) how to build it (2) how to run and test the App in IGB
            • Run the code. Developer should be able to install the App and try it out in IGB.

            Please make comments here for SK.

            Goal: This App is meant to serve as an example for how an App developer can get access to items in the IGB display. Developers (e.g., people like us) are the target audience for this App.

            Show
            ann.loraine Ann Loraine added a comment - To review: Look at the code. Developer should be able to read the code and know (1) how to build it (2) how to run and test the App in IGB Run the code. Developer should be able to install the App and try it out in IGB. Please make comments here for SK. Goal: This App is meant to serve as an example for how an App developer can get access to items in the IGB display. Developers (e.g., people like us) are the target audience for this App.
            Hide
            prutha Prutha Kulkarni (Inactive) added a comment - - edited

            Shamika Gajanan Kulkarni, I have reviewed the code for the Demo App. It is very easy to understand.
            IGB service is used to get sequence map view. After that a for loop is ran on the sequence map to get selected syms. And for each score entry for the sym, you have calculated average.
            When I was reviewing your code, I have noticed that the target folder is accidentally pushed to the app repository which shouldn't be there. Along with that there is git.properties file in the resource directory of the source folder which also should be removed from the repository.
            Other than that, everything is fine. Even the message popup that you are showing on click of Tools>"Get Average Score" is perfect.
            Moving the ticket to TO DO. Once you're done removing this folder/file from the repository, let me know so that I can move it forward to Ready for pull request.
            Thanks.

            Show
            prutha Prutha Kulkarni (Inactive) added a comment - - edited Shamika Gajanan Kulkarni , I have reviewed the code for the Demo App. It is very easy to understand. IGB service is used to get sequence map view. After that a for loop is ran on the sequence map to get selected syms. And for each score entry for the sym, you have calculated average. When I was reviewing your code, I have noticed that the target folder is accidentally pushed to the app repository which shouldn't be there. Along with that there is git.properties file in the resource directory of the source folder which also should be removed from the repository. Other than that, everything is fine. Even the message popup that you are showing on click of Tools>"Get Average Score" is perfect. Moving the ticket to TO DO. Once you're done removing this folder/file from the repository, let me know so that I can move it forward to Ready for pull request. Thanks.
            Hide
            shamika Shamika Gajanan Kulkarni (Inactive) added a comment - - edited

            I am sorry I overlooked this fact and I have made the necessary changes.
            Also, Dr. Loraine suggested a few changes:
            1) To add a new AppDecription.md file that will be visible in the App Manager and provide instructions to the user on how to use the app.
            2) To modify the existing README.md file providing the user with instructions on how to install the app. The README.md file will only be visible on bitbucket. The App Manager should show the AppDescription.md data.
            The changes have been implemented and usability testing has been conducted for the same.
            Kindly check the link below and let me know if you observe any more changes that need to be done. Thank you for the review.
            https://bitbucket.org/skulka2710/get-average-score/src/master/

            Show
            shamika Shamika Gajanan Kulkarni (Inactive) added a comment - - edited I am sorry I overlooked this fact and I have made the necessary changes. Also, Dr. Loraine suggested a few changes: 1) To add a new AppDecription.md file that will be visible in the App Manager and provide instructions to the user on how to use the app. 2) To modify the existing README.md file providing the user with instructions on how to install the app. The README.md file will only be visible on bitbucket. The App Manager should show the AppDescription.md data. The changes have been implemented and usability testing has been conducted for the same. Kindly check the link below and let me know if you observe any more changes that need to be done. Thank you for the review. https://bitbucket.org/skulka2710/get-average-score/src/master/
            Hide
            prutha Prutha Kulkarni (Inactive) added a comment -

            Shamika Gajanan Kulkarni, I have checked both markdown files, the one after adding plugin to the IGB app manager which is AppDescription as well as the one which is displayed on the bitbucket i.e. README.
            Moving the ticket forward. You can now submit a PR for the same.

            Show
            prutha Prutha Kulkarni (Inactive) added a comment - Shamika Gajanan Kulkarni , I have checked both markdown files, the one after adding plugin to the IGB app manager which is AppDescription as well as the one which is displayed on the bitbucket i.e. README. Moving the ticket forward. You can now submit a PR for the same.
            Hide
            shamika Shamika Gajanan Kulkarni (Inactive) added a comment -

            Thank you for the reviews.
            Since the repository is a separate one for the Demo App - Get Average Score, the ownership to the repo is transferred to LoraineLabs. Moving the ticket to PR Submitted. Kindly review.

            Show
            shamika Shamika Gajanan Kulkarni (Inactive) added a comment - Thank you for the reviews. Since the repository is a separate one for the Demo App - Get Average Score, the ownership to the repo is transferred to LoraineLabs. Moving the ticket to PR Submitted. Kindly review.

              People

              • Assignee:
                ann.loraine Ann Loraine
                Reporter:
                ann.loraine Ann Loraine
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated: