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

Update Galaxy to IGB documentation

    Details

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

      Description

      Situation: Our documentation on viewing Galaxy files in IGB is out of date.

      Task: Update the following documentation:
      https://wiki.bioviz.org/confluence/display/igbman/View+Galaxy+files+in+IGB
      https://wiki.bioviz.org/confluence/display/ITD/Galaxy

        Attachments

          Issue Links

            Activity

            nfreese Nowlan Freese created issue -
            nfreese Nowlan Freese made changes -
            Field Original Value New Value
            Epic Link IGBF-1880 [ 17970 ]
            nfreese Nowlan Freese made changes -
            Link This issue relates to IGBF-3960 [ IGBF-3960 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            Hide
            pkulzer Paige Kulzer (Inactive) added a comment -

            Changes to the "View Galaxy files in IGB" page:

            • Updated images and callouts
            • Added mention of IGB-supported file formats
            • Changed bulleted list to numbered list

            Changes to the "Galaxy" release documentation:

            • Clarified the instructions for opening file types
            • Added CRAM to the checklist

            Next steps for Ann Loraine:

            1. Create and add a new file, cram.xml, to Galaxy's source code (link: https://github.com/galaxyproject/galaxy/tree/1b11742252b6cfe6b6cc1ee4c52f7f4ffa386f06/lib/galaxy/datatypes/display_applications/configs/igb)
            2. Add a CRAM file to the Open Galaxy files in Integrated Genome Browser Galaxy History (link: https://usegalaxy.org/published/history?id=4d6cb5a8a3640b22). I'd suggest maybe using the one that was subsetted to a smaller size as part of IGBF-3841.
            Show
            pkulzer Paige Kulzer (Inactive) added a comment - Changes to the "View Galaxy files in IGB" page: Updated images and callouts Added mention of IGB-supported file formats Changed bulleted list to numbered list Changes to the "Galaxy" release documentation: Clarified the instructions for opening file types Added CRAM to the checklist Next steps for Ann Loraine : Create and add a new file, cram.xml, to Galaxy's source code (link: https://github.com/galaxyproject/galaxy/tree/1b11742252b6cfe6b6cc1ee4c52f7f4ffa386f06/lib/galaxy/datatypes/display_applications/configs/igb ) Add a CRAM file to the Open Galaxy files in Integrated Genome Browser Galaxy History (link: https://usegalaxy.org/published/history?id=4d6cb5a8a3640b22 ). I'd suggest maybe using the one that was subsetted to a smaller size as part of IGBF-3841 .
            pkulzer Paige Kulzer (Inactive) made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Assignee Paige Kulzer [ pkulzer ] Ann Loraine [ aloraine ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status First Level Review in Progress [ 10301 ] To-Do [ 10305 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Sprint Fall 5 [ 206 ] Fall 6 [ 207 ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 6 [ 207 ] Fall 6, Fall 7 [ 207, 208 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            Hide
            ann.loraine Ann Loraine added a comment - - edited

            Request for Paige Kulzer:

            • Please separate the work of enabling Galaxy to create "Open in IGB" links for CRAM files from the task of updating our documentation.
            • Make a new ticket titled "Enable IGB to open Galaxy CRAM format data sets"
              This is a new feature and will require a good amount of effort - including figuring out how to test that the new capability is working as expected. It will also require cloning the Galaxy repo and deploying it on a local machine for development and testing. In light of the effort required, the story points should probably be set at 4.
            • Hold off on stating that IGB supports opening Galaxy CRAM files in any documentation before the feature is implemented.
            • For this new ticket, I recommend linking older tickets from previous efforts when we added support for opening BAM and other file types from the Galaxy interface.
            Show
            ann.loraine Ann Loraine added a comment - - edited Request for Paige Kulzer : Please separate the work of enabling Galaxy to create "Open in IGB" links for CRAM files from the task of updating our documentation. Make a new ticket titled "Enable IGB to open Galaxy CRAM format data sets" This is a new feature and will require a good amount of effort - including figuring out how to test that the new capability is working as expected. It will also require cloning the Galaxy repo and deploying it on a local machine for development and testing. In light of the effort required, the story points should probably be set at 4. Hold off on stating that IGB supports opening Galaxy CRAM files in any documentation before the feature is implemented. For this new ticket, I recommend linking older tickets from previous efforts when we added support for opening BAM and other file types from the Galaxy interface.
            ann.loraine Ann Loraine made changes -
            Assignee Ann Loraine [ aloraine ] Paige Kulzer [ pkulzer ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            Hide
            pkulzer Paige Kulzer (Inactive) added a comment -

            Thanks for the comment, Ann!

            I've created a new ticket titled "Enable IGB to open Galaxy CRAM format data sets" per your instructions and have linked it to this ticket. I've removed the CRAM checkbox from our release documentation for the time being. I will now link any tickets I can find where support was added for other file types from the Galaxy interface, and then I will close this ticket.

            Show
            pkulzer Paige Kulzer (Inactive) added a comment - Thanks for the comment, Ann! I've created a new ticket titled "Enable IGB to open Galaxy CRAM format data sets" per your instructions and have linked it to this ticket. I've removed the CRAM checkbox from our release documentation for the time being. I will now link any tickets I can find where support was added for other file types from the Galaxy interface, and then I will close this ticket.
            pkulzer Paige Kulzer (Inactive) made changes -
            Link This issue relates to IGBF-4011 [ IGBF-4011 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]

              People

              • Assignee:
                pkulzer Paige Kulzer (Inactive)
                Reporter:
                nfreese Nowlan Freese
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: