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

Add samtools filter by and color by options for CR and CB tags

    Details

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

      Description

      For this ticket, explore the prospect of adding samtools tags to right-click filter function so that user can filter reads from the track based on samtools tags. For the purposes of this ticket, adding CR, cellular barcode sequence bases, as a filter option so that users can filter reads based on cell identifiers.

      Adding this filter may help in understanding the UMI count matrix and to make a plan to add features for single cell data.

        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 -
            Link This issue relates to IGBF-3880 [ IGBF-3880 ]
            karthik Karthik Raveendran made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            karthik Karthik Raveendran made changes -
            Assignee Ann Loraine [ aloraine ] Karthik Raveendran [ karthik ]
            karthik Karthik Raveendran made changes -
            Summary Investigate samtools tags filter Investigate samtools tags filter by and color by options
            Hide
            karthik Karthik Raveendran added a comment -

            Completed implementing filter by samtools tags options. We can filter reads by CR number which is cell barcode number. Working on the color by option.

            Show
            karthik Karthik Raveendran added a comment - Completed implementing filter by samtools tags options. We can filter reads by CR number which is cell barcode number. Working on the color by option.
            Show
            karthik Karthik Raveendran added a comment - Color by commit: https://bitbucket.org/KarthikRavee91/karthikfork-igb/commits/771e8ab7b8a4f268bbe249a65a96aa3146703c9f Filter by commit: https://bitbucket.org/KarthikRavee91/karthikfork-igb/commits/771e8ab7b8a4f268bbe249a65a96aa3146703c9f
            karthik Karthik Raveendran made changes -
            Attachment After Filter by CR.png [ 18495 ]
            Attachment Before Filter by CR.png [ 18496 ]
            karthik Karthik Raveendran made changes -
            Attachment After Color by CR.png [ 18497 ]
            Attachment Before Color by CR.png [ 18498 ]
            karthik Karthik Raveendran made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            karthik Karthik Raveendran made changes -
            Assignee Karthik Raveendran [ karthik ]
            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 -
            Assignee Karthik Raveendran [ karthik ]
            Hide
            karthik Karthik Raveendran added a comment -

            During a demo showing Nowlan Freese the new filter and color options there was an error which I was not able to replicate after that. Probably someone else testing it would be better. Including the link to download installer page in my repo: https://bitbucket.org/KarthikRavee91/karthikfork-igb/downloads/

            Show
            karthik Karthik Raveendran added a comment - During a demo showing Nowlan Freese the new filter and color options there was an error which I was not able to replicate after that. Probably someone else testing it would be better. Including the link to download installer page in my repo: https://bitbucket.org/KarthikRavee91/karthikfork-igb/downloads/
            karthik Karthik Raveendran made changes -
            Link This issue relates to IGBF-3899 [ IGBF-3899 ]
            karthik Karthik Raveendran made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            karthik Karthik Raveendran made changes -
            Assignee Karthik Raveendran [ karthik ]
            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 -
            Assignee Karthik Raveendran [ karthik ]
            Hide
            karthik Karthik Raveendran added a comment - - edited

            Testing Protocol

            Prepare for Test:

            1. Go to https://bitbucket.org/KarthikRavee91/karthikfork-igb/downloads/ and download the IGBF-3881 installer relevant to your OS
            2. Install and open that IGB
            3. Download the quickload folder https://drive.google.com/drive/folders/14LRo1FQ0daM0oZKZ17bo8tuW3qv0GAKk?usp=drive_link
            • Add the quickload to Data Sources as " 1k A375 "
            • Press Alt+P and click on the Data Sources tab
            • Click on Add
            • Add the path of the quickload you just downloaded
            • Use " 1k A375 " as the server name
            1. Click on Homo Sapiens in the carousel to load the human reference genome and click to select the track
            2. Go to the annotation tab in the bottom panel of IGB
            3. In the track height section, check Lock Track height and set height to 150
            4. Go Data Access tab and expand 1k A375 folder on Available Data section
            5. Check the only file under that folder
            6. Go to the search bar on top left and search for DPH2
            7. Click on Load Data and Load Sequence (top-right)
            8. Right-click on one of the reads and click on Get Info
            9. In the window that appears, scroll to the key "CR" and copy the value and close window

            Feature Test #1

            1. Right-click on the 1k A375 track and click on "Color By"
            2. Click OK
            3. Select Samtools Tags in Color By dropdown
            4. Paste the CR value in the value text box
            5. Click OK

            Expected Observation: Reads with the CR value that you copied turns green and maybe some other reads as well and everything else turns red. Please check if the green ones have the same CR value as the one that you copied.

            Feature Test #2

            1. Right-click on the 1k A375 track and click on "Filter..."
            2. Click on add button
            3. Select Samtools Tags in Show only
            4. Paste the CR value in the value text box and select "=" in the comparator dropdown
            5. Click OK

            Expected Observation: Except for the reads with the CR value that you copied, everything else disappears. Please check if the ones that remain have the same CR value as the one that you copied.

            Show
            karthik Karthik Raveendran added a comment - - edited Testing Protocol Prepare for Test: Go to https://bitbucket.org/KarthikRavee91/karthikfork-igb/downloads/ and download the IGBF-3881 installer relevant to your OS Install and open that IGB Download the quickload folder https://drive.google.com/drive/folders/14LRo1FQ0daM0oZKZ17bo8tuW3qv0GAKk?usp=drive_link Add the quickload to Data Sources as " 1k A375 " Press Alt+P and click on the Data Sources tab Click on Add Add the path of the quickload you just downloaded Use " 1k A375 " as the server name Click on Homo Sapiens in the carousel to load the human reference genome and click to select the track Go to the annotation tab in the bottom panel of IGB In the track height section, check Lock Track height and set height to 150 Go Data Access tab and expand 1k A375 folder on Available Data section Check the only file under that folder Go to the search bar on top left and search for DPH2 Click on Load Data and Load Sequence (top-right) Right-click on one of the reads and click on Get Info In the window that appears, scroll to the key "CR" and copy the value and close window Feature Test #1 Right-click on the 1k A375 track and click on "Color By" Click OK Select Samtools Tags in Color By dropdown Paste the CR value in the value text box Click OK Expected Observation: Reads with the CR value that you copied turns green and maybe some other reads as well and everything else turns red. Please check if the green ones have the same CR value as the one that you copied. Feature Test #2 Right-click on the 1k A375 track and click on "Filter..." Click on add button Select Samtools Tags in Show only Paste the CR value in the value text box and select "=" in the comparator dropdown Click OK Expected Observation: Except for the reads with the CR value that you copied, everything else disappears. Please check if the ones that remain have the same CR value as the one that you copied.
            karthik Karthik Raveendran made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            karthik Karthik Raveendran made changes -
            Assignee Karthik Raveendran [ karthik ]
            Hide
            pkulzer Paige Kulzer added a comment - - edited

            Thank you for the detailed protocol, Karthik Raveendran! This worked really well!

            I walked through all of the steps outlined above and got the expected results as described for each Feature Test. I also zoomed out a bit from the DPH2 gene and made sure that the behavior I was seeing at that locus was occurring elsewhere in previously unloaded parts of the genome, too.

            For reference, the CR value I was using was: ACGAAAGGTGCTTCCG
            And the name of the read I initially clicked on to get that value was: A00984:1229:HTJHLDRX3:2:2137:16938:4773

            Show
            pkulzer Paige Kulzer added a comment - - edited Thank you for the detailed protocol, Karthik Raveendran ! This worked really well! I walked through all of the steps outlined above and got the expected results as described for each Feature Test. I also zoomed out a bit from the DPH2 gene and made sure that the behavior I was seeing at that locus was occurring elsewhere in previously unloaded parts of the genome, too. For reference, the CR value I was using was: ACGAAAGGTGCTTCCG And the name of the read I initially clicked on to get that value was: A00984:1229:HTJHLDRX3:2:2137:16938:4773
            pkulzer Paige Kulzer made changes -
            Assignee Paige Kulzer [ pkulzer ]
            pkulzer Paige Kulzer made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            pkulzer Paige Kulzer made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            pkulzer Paige Kulzer made changes -
            Assignee Paige Kulzer [ pkulzer ] Karthik Raveendran [ karthik ]
            karthik Karthik Raveendran made changes -
            Link This issue relates to IGBF-3897 [ IGBF-3897 ]
            nfreese Nowlan Freese made changes -
            Summary Investigate samtools tags filter by and color by options Add samtools filter by and color by options for CR and CB tags
            ann.loraine Ann Loraine made changes -
            Sprint Fall 1 [ 202 ] Fall 1, Fall 2 [ 202, 203 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            nfreese Nowlan Freese made changes -
            Link This issue relates to IGBF-3907 [ IGBF-3907 ]
            Hide
            karthik Karthik Raveendran added a comment -

            Submitting a pull request on this branch is put on hold until the release branch is created for the Release IGB 10.1.0.

            Show
            karthik Karthik Raveendran added a comment - Submitting a pull request on this branch is put on hold until the release branch is created for the Release IGB 10.1.0.
            karthik Karthik Raveendran made changes -
            Link This issue is blocked by IGBF-3867 [ IGBF-3867 ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 1, Fall 2 [ 202, 203 ] Fall 1, Fall 2, Fall 3 [ 202, 203, 204 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            karthik Karthik Raveendran made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            Show
            karthik Karthik Raveendran added a comment - PR Submitted: https://bitbucket.org/lorainelab/integrated-genome-browser/pull-requests/1047
            karthik Karthik Raveendran made changes -
            Assignee Karthik Raveendran [ karthik ] Ann Loraine [ aloraine ]
            ann.loraine Ann Loraine 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 Ann Loraine [ aloraine ]
            Hide
            nfreese Nowlan Freese added a comment -

            Tested with main branch installer on Mac using Karthik's instructions above. Everything working correctly, no errors in the logs.

            Closing ticket.

            Show
            nfreese Nowlan Freese added a comment - Tested with main branch installer on Mac using Karthik's instructions above. Everything working correctly, no errors in the logs. Closing ticket.
            nfreese Nowlan Freese made changes -
            Assignee Karthik Raveendran [ karthik ]
            nfreese Nowlan Freese made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            nfreese Nowlan Freese made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]

              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: