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

Implement ability to persist Heatmap setting between sessions

    Details

      Description

      This story has been created to serve as a reminder to implement the ability to save/persist the Color by Score Heatmap setting for a track.

      This improvement was brought to us by a user who pointed out that in order to view a certain heatmap setting for a track, the heatmap must be reconfigured each time you start a new IGB session.

      If you have any comments on how the feature could be implemented, please leave them below.

        Attachments

          Issue Links

            Activity

            Hide
            mason Mason Meyer (Inactive) added a comment -

            My testing verifies that this story has been resolved. Heatmap settings are now being persisted between sessions for each track, until IGB Preferences are reset to default. Also, several heatmap settings may be stored for each track depending on the field being colored by, which is excellent. The color by feature must still be applied each session, but I am assuming that this is expected. If we wish for the saved colors to be automatically applied upon loading a track with color data, I can create a new story to track this, but I will wait until I hear that the behavior is desired. The heatmap setting persistence is also working for custom genome tracks, which is excellent. Since this story has been resolved, it will now be closed. Great work!

            Show
            mason Mason Meyer (Inactive) added a comment - My testing verifies that this story has been resolved. Heatmap settings are now being persisted between sessions for each track, until IGB Preferences are reset to default. Also, several heatmap settings may be stored for each track depending on the field being colored by, which is excellent. The color by feature must still be applied each session, but I am assuming that this is expected. If we wish for the saved colors to be automatically applied upon loading a track with color data, I can create a new story to track this, but I will wait until I hear that the behavior is desired. The heatmap setting persistence is also working for custom genome tracks, which is excellent. Since this story has been resolved, it will now be closed. Great work!
            Hide
            mason Mason Meyer (Inactive) added a comment -

            I have created IGBF-1127 (Persist Track Filters between sessions) to separately track the user requested issue of persisting track filters between sessions. Also, there was no Biostars post for that request, but there was a JIRA User Support story (HELP-208), so I have linked that story to IGBF-1127.

            Show
            mason Mason Meyer (Inactive) added a comment - I have created IGBF-1127 (Persist Track Filters between sessions) to separately track the user requested issue of persisting track filters between sessions. Also, there was no Biostars post for that request, but there was a JIRA User Support story ( HELP-208 ), so I have linked that story to IGBF-1127 .
            Hide
            ann.loraine Ann Loraine added a comment -

            Good question. I think actually it will be fine — I've shown Devdatta how IGB "remembers" color and other track settings between sessions. This works quite well – everything you configure (except Color by.. settings) for a track is "remembered" in future sessions. I believe this is using a sub-system in IGB that is different from the session saving and session reloading feature. (Which is buggy, as you mentioned.)

            Show
            ann.loraine Ann Loraine added a comment - Good question. I think actually it will be fine — I've shown Devdatta how IGB "remembers" color and other track settings between sessions. This works quite well – everything you configure (except Color by.. settings) for a track is "remembered" in future sessions. I believe this is using a sub-system in IGB that is different from the session saving and session reloading feature. (Which is buggy, as you mentioned.)
            Hide
            mason Mason Meyer (Inactive) added a comment -

            After reading notes from the discussion above, I understand that you are planning to use the existing preferences sub-system for the heatmap persistence feature. I wanted to point out that the session saving feature currently does not work for custom genomes. Do you think that may mean heatmap settings may not be persisted for custom genome tracks with this planned implementation? If you think that is a major problem, we may need to figure out another way to implement persistence of heatmap settings or we could plan to make session saving work for custom genomes instead.

            Show
            mason Mason Meyer (Inactive) added a comment - After reading notes from the discussion above, I understand that you are planning to use the existing preferences sub-system for the heatmap persistence feature. I wanted to point out that the session saving feature currently does not work for custom genomes. Do you think that may mean heatmap settings may not be persisted for custom genome tracks with this planned implementation? If you think that is a major problem, we may need to figure out another way to implement persistence of heatmap settings or we could plan to make session saving work for custom genomes instead.
            Hide
            ann.loraine Ann Loraine added a comment -

            Requirement:

            If a track has been configured to use a heatmap, its heatmap settings should be preserved between sessions, even if the user has changed from heatmap visualization to something else.

            Show
            ann.loraine Ann Loraine added a comment - Requirement: If a track has been configured to use a heatmap, its heatmap settings should be preserved between sessions, even if the user has changed from heatmap visualization to something else.
            Hide
            ann.loraine Ann Loraine added a comment -

            3/8/17 discussion - Ann & Devdatta:

            We discussed how to implement this. IGB already has a system for persisting track sessions between sessions using a preferences sub-system within IGB.
            Also, we noted that IGB previously had a feature that enabled users to "Export Preferences" and "Import Preferences." Go to the on-line User's Guide and search "Export Preferences" to find documentation.
            In addition, Devdatta noted that there is an "action" object in IGB that performs export of preferences, but this action is not reachable within the GUI, although the Preferences Toolbar window refers to it. (See attachment.)

            Probably the safest, smartest, most robust approach will be to use the current preferences subsystem architecture in IGB to save heatmap settings. However, we imagine there will be many parameters to capture from a session. One challenge will be ensuring synchronization between the heatmap editor GUI widget and tracks that have been configured with heatmap settings.

            Show
            ann.loraine Ann Loraine added a comment - 3/8/17 discussion - Ann & Devdatta: We discussed how to implement this. IGB already has a system for persisting track sessions between sessions using a preferences sub-system within IGB. Also, we noted that IGB previously had a feature that enabled users to "Export Preferences" and "Import Preferences." Go to the on-line User's Guide and search "Export Preferences" to find documentation. In addition, Devdatta noted that there is an "action" object in IGB that performs export of preferences, but this action is not reachable within the GUI, although the Preferences Toolbar window refers to it. (See attachment.) Probably the safest, smartest, most robust approach will be to use the current preferences subsystem architecture in IGB to save heatmap settings. However, we imagine there will be many parameters to capture from a session. One challenge will be ensuring synchronization between the heatmap editor GUI widget and tracks that have been configured with heatmap settings.
            Hide
            ann.loraine Ann Loraine added a comment -

            Mason, please create a separate issue for the request to persist filter-by options between sessions. Also, please provide a link to the BioStars post, if there was one.

            Show
            ann.loraine Ann Loraine added a comment - Mason, please create a separate issue for the request to persist filter-by options between sessions. Also, please provide a link to the BioStars post, if there was one.
            Hide
            mason Mason Meyer (Inactive) added a comment -

            The user has also requested that we add the ability to persist "filter by" options for tracks as well. We should discuss what other aspects of IGB should be persisted to increase usability for people who work often with IGB.

            Show
            mason Mason Meyer (Inactive) added a comment - The user has also requested that we add the ability to persist "filter by" options for tracks as well. We should discuss what other aspects of IGB should be persisted to increase usability for people who work often with IGB.

              People

              • Assignee:
                mason Mason Meyer (Inactive)
                Reporter:
                mason Mason Meyer (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: