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

Add an import button to SAMtags dialog window

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 10.2.0
    • Labels:
      None

      Description

      Provide users a way to import tag values and colors from a saved file. The file format would be determined by the output of dimensionality reduction techniques like UMAP or t-SNE. So, it is highly likely to be a Seurat object based file format but that is yet to be determined. The purpose of this task is to experiment how the import button would look like and how the existing functionality needs to be generalized, if needed, receive the data in whatever form it is uploaded. Vice versa, this task could inform us how the format of the data should be modified to fit the functionality and that could help with API development in the next steps.

        Attachments

          Issue Links

            Activity

            karthik Karthik Raveendran created issue -
            karthik Karthik Raveendran made changes -
            Field Original Value New Value
            Epic Link IGBF-3765 [ 22984 ]
            karthik Karthik Raveendran made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            Hide
            karthik Karthik Raveendran added a comment - - edited

            A version of the import button was demo to Dr. Loraine and Dr. Freese. Takeaways and observations from that meeting:

            1) When reads don't match the tag values provided by the user, its currently colored light grey. However, we found reads that may not have the tag itself . There was a suggestion that reads like that should be light grey and the other unmatched reads should be regular grey. However, if users are creating the import text file from a R program they can filter out reads that does not have the tag at all in the metadata.
            2) The Edit Tags and Colors table is not scrollable right now. Needs to be fixed
            3) The buttons and table header in Edit Tags and Colors window changes sizes when the window is resized. Needs to be addressed.
            4) One of the conditions for the import button workflow is checking the headers in the file. The file headers is user defined so cannot really predict that. We just need to check if there is a tag column and a color column in the file and map that to reads.

            Show
            karthik Karthik Raveendran added a comment - - edited A version of the import button was demo to Dr. Loraine and Dr. Freese. Takeaways and observations from that meeting: 1) When reads don't match the tag values provided by the user, its currently colored light grey. However, we found reads that may not have the tag itself . There was a suggestion that reads like that should be light grey and the other unmatched reads should be regular grey. However, if users are creating the import text file from a R program they can filter out reads that does not have the tag at all in the metadata. 2) The Edit Tags and Colors table is not scrollable right now. Needs to be fixed 3) The buttons and table header in Edit Tags and Colors window changes sizes when the window is resized. Needs to be addressed. 4) One of the conditions for the import button workflow is checking the headers in the file. The file headers is user defined so cannot really predict that. We just need to check if there is a tag column and a color column in the file and map that to reads.
            ann.loraine Ann Loraine made changes -
            Sprint Spring 5 [ 214 ] Spring 5, Spring 6 [ 214, 215 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            karthik Karthik Raveendran made changes -
            Status In Progress [ 3 ] To-Do [ 10305 ]
            karthik Karthik Raveendran made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            karthik Karthik Raveendran made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            karthik Karthik Raveendran made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            karthik Karthik Raveendran made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            karthik Karthik Raveendran made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            karthik Karthik Raveendran made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            karthik Karthik Raveendran made changes -
            Status Reviewing Pull Request [ 10303 ] To-Do [ 10305 ]
            karthik Karthik Raveendran made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            nfreese Nowlan Freese made changes -
            Sprint Spring 5, Spring 6 [ 214, 215 ] Spring 5, Spring 6, Spring 7 [ 214, 215, 216 ]
            nfreese Nowlan Freese made changes -
            Rank Ranked higher
            karthik Karthik Raveendran made changes -
            Link This issue relates to IGBF-4193 [ IGBF-4193 ]
            karthik Karthik Raveendran made changes -
            Attachment pbmc_cell_color_info.txt [ 18677 ]
            karthik Karthik Raveendran made changes -
            Attachment 3k PMBC from a Healthy Donor.zip [ 18678 ]
            Hide
            karthik Karthik Raveendran added a comment - - edited

            Added an import button to Color by SAMtags window. See commit

            Testing Protocol:

            1. Load H_sapiens_Feb_2009 in Human genome (hg19)
            2. Load 3k PMBC from a Healthy Donor.zip to Data Sources (see attachments to ticket)
            3. Go to gene GNLY using the search function in top left
            4. Right click in the track title -> Choose Color by -> Choose SAMtags
            5. Select CB as tag value and click Import button
            6. Select the [^pbmc_cel_color_info.txt] from the File Chooser and click ok
              # Expected behavior: Edit Tag and Color table pops up with all the values from the file
            7. Click on Save and Apply and Click OK
            8. Wait until the reads are colored.
            Show
            karthik Karthik Raveendran added a comment - - edited Added an import button to Color by SAMtags window. See commit Testing Protocol: Load H_sapiens_Feb_2009 in Human genome (hg19) Load 3k PMBC from a Healthy Donor.zip to Data Sources (see attachments to ticket) Go to gene GNLY using the search function in top left Right click in the track title -> Choose Color by -> Choose SAMtags Select CB as tag value and click Import button Select the [^pbmc_cel_color_info.txt] from the File Chooser and click ok # Expected behavior: Edit Tag and Color table pops up with all the values from the file Click on Save and Apply and Click OK Wait until the reads are colored.
            karthik Karthik Raveendran made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            karthik Karthik Raveendran made changes -
            Assignee Karthik Raveendran [ karthik ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            Hide
            pkulzer Paige Kulzer (Inactive) added a comment -

            Tested Karthik's branch on Mac by following the above protocol. The Color by table populates with the values from the file as expected. However, numerous (>25) rows were also appended to the end of the table after importing this file even though there's only one blank line in the file. These rows have an empty Tag Value column and Color set to grey.

            Show
            pkulzer Paige Kulzer (Inactive) added a comment - Tested Karthik's branch on Mac by following the above protocol. The Color by table populates with the values from the file as expected. However, numerous (>25) rows were also appended to the end of the table after importing this file even though there's only one blank line in the file. These rows have an empty Tag Value column and Color set to grey.
            pkulzer Paige Kulzer (Inactive) made changes -
            Status First Level Review in Progress [ 10301 ] Needs 1st Level Review [ 10005 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ] Karthik Raveendran [ karthik ]
            Hide
            karthik Karthik Raveendran added a comment - - edited

            The Edit Tag and Color table starts with a 100 rows. When a file is imported, the table adds rows with respect to rows in the file. So the additional rows that was observed is the initial 100 rows. However, the light grey color pre-selected can be confusing. Will fix that in next commit.

            Show
            karthik Karthik Raveendran added a comment - - edited The Edit Tag and Color table starts with a 100 rows. When a file is imported, the table adds rows with respect to rows in the file. So the additional rows that was observed is the initial 100 rows. However, the light grey color pre-selected can be confusing. Will fix that in next commit.
            karthik Karthik Raveendran made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            karthik Karthik Raveendran made changes -
            Status First Level Review in Progress [ 10301 ] To-Do [ 10305 ]
            karthik Karthik Raveendran made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            karthik Karthik Raveendran made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            Hide
            karthik Karthik Raveendran added a comment -

            Changes above have been implemented. See commit

            Show
            karthik Karthik Raveendran added a comment - Changes above have been implemented. See commit
            karthik Karthik Raveendran made changes -
            Assignee Karthik Raveendran [ karthik ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            Hide
            pkulzer Paige Kulzer (Inactive) added a comment -

            This is much clearer now, thank you Karthik! Recommending PR!

            Show
            pkulzer Paige Kulzer (Inactive) added a comment - This is much clearer now, thank you Karthik! Recommending PR!
            pkulzer Paige Kulzer (Inactive) made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ] Karthik Raveendran [ karthik ]
            Show
            karthik Karthik Raveendran added a comment - PR Submitted. https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/1074
            karthik Karthik Raveendran made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            nfreese Nowlan Freese made changes -
            Assignee Karthik Raveendran [ karthik ] Ann Loraine [ aloraine ]
            ann.loraine Ann Loraine made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            ann.loraine Ann Loraine made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            Hide
            ann.loraine Ann Loraine added a comment -

            PR is merged. New installers are built and deployed to bioviz.org Early Access section.

            Ready for testing.

            Show
            ann.loraine Ann Loraine added a comment - PR is merged. New installers are built and deployed to bioviz.org Early Access section. Ready for testing.
            ann.loraine Ann Loraine made changes -
            Assignee Ann Loraine [ aloraine ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            Hide
            pkulzer Paige Kulzer (Inactive) added a comment -

            Installed the new Early Access release and tested on my Mac, the import button is working as expected. The reads are colored after a few seconds and the text file import works whether the header is present or not.

            Closing this ticket!

            Show
            pkulzer Paige Kulzer (Inactive) added a comment - Installed the new Early Access release and tested on my Mac, the import button is working as expected. The reads are colored after a few seconds and the text file import works whether the header is present or not. Closing this ticket!
            pkulzer Paige Kulzer (Inactive) made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ] Karthik Raveendran [ karthik ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Fix Version/s 10.2.0 [ 11100 ]

              People

              • Assignee:
                karthik Karthik Raveendran
                Reporter:
                karthik Karthik Raveendran
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: