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

Create documentation for MetaCerberus

    Details

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

      Description

      Situation: Dr. Rick White is looking for a way to point users of his program MetaCerberus to some sort of visualization tool, such as IGB! MetaCerberus predicts gene models and creates a gff file. We've confirmed that this output is viewable in IGB.

      Task: Create documentation to add to MetaCerberus' GitHub page about visualizing the output in IGB. Meet with Dr. White's team to discuss how best to integrate the documentation.

        Attachments

          Issue Links

            Activity

            pkulzer Paige Kulzer created issue -
            pkulzer Paige Kulzer made changes -
            Field Original Value New Value
            Epic Link IGBF-2809 [ 19325 ]
            nfreese Nowlan Freese made changes -
            Description Situation: Dr. Rick White is looking for a way to point users of his program MetaCerberus to some sort of visualization tool, such as IGB! We've confirmed that the output of this program is

            Task: Create documentation to add to [MetaCerberus' GitHub page|https://github.com/raw-lab/MetaCerberus] about visualizing the output in IGB.
            Situation: Dr. Rick White is looking for a way to point users of his program MetaCerberus to some sort of visualization tool, such as IGB! MetaCerberus predicts gene models and creates a gff file. We've confirmed that this output is viewable in IGB.

            Task: Create documentation to add to [MetaCerberus' GitHub page|https://github.com/raw-lab/MetaCerberus] about visualizing the output in IGB. Meet with Dr. White's team to discuss how best to integrate the documentation.
            Hide
            nfreese Nowlan Freese added a comment -

            Dr. White's lab emails:
            Jose Figueroa <jlfiguer@charlotte.edu>,
            Joshua Hensley <jhensl19@charlotte.edu>,
            Madeline Bellanger <mbellang@charlotte.edu>,
            Andra Buchan <abuchan@charlotte.edu>,
            Andrew Redinbo <aredinbo@charlotte.edu>,
            Stephanie Wiedman <swiedma1@charlotte.edu>

            Show
            nfreese Nowlan Freese added a comment - Dr. White's lab emails: Jose Figueroa <jlfiguer@charlotte.edu>, Joshua Hensley <jhensl19@charlotte.edu>, Madeline Bellanger <mbellang@charlotte.edu>, Andra Buchan <abuchan@charlotte.edu>, Andrew Redinbo <aredinbo@charlotte.edu>, Stephanie Wiedman <swiedma1@charlotte.edu>
            pkulzer Paige Kulzer made changes -
            Sprint Fall 1 [ 202 ] Fall 2 [ 203 ]
            Hide
            pkulzer Paige Kulzer added a comment - - edited

            Nowlan and I met with Joshua (Josh) Hensley <jhensl19@charlotte.edu> on Wednesday (Sep 18) to discuss which files should be used to create this documentation.

            For context, we've found Metacerberus output (genomes (.fna) and annotations (.gff)) on their GitHub page that we're able to view in IGB, but it's variable whether that output is behaving properly depending on which .fna and .gff files I grab. Is this an issue with Metacerberus having variable output that we'll need to account for, or was I simply unable to find an example of typical Metacerberus output?

            Next steps: Get sample output from Josh that we can use for the documentation. He is also looking into the possible variability of this output for us.

            Show
            pkulzer Paige Kulzer added a comment - - edited Nowlan and I met with Joshua (Josh) Hensley <jhensl19@charlotte.edu> on Wednesday (Sep 18) to discuss which files should be used to create this documentation. For context, we've found Metacerberus output (genomes (.fna) and annotations (.gff)) on their GitHub page that we're able to view in IGB, but it's variable whether that output is behaving properly depending on which .fna and .gff files I grab. Is this an issue with Metacerberus having variable output that we'll need to account for, or was I simply unable to find an example of typical Metacerberus output? Next steps: Get sample output from Josh that we can use for the documentation. He is also looking into the possible variability of this output for us.
            pkulzer Paige Kulzer made changes -
            Link This issue is blocked by IGBF-3924 [ IGBF-3924 ]
            pkulzer Paige Kulzer made changes -
            Sprint Fall 2 [ 203 ] Fall 3 [ 204 ]
            Hide
            pkulzer Paige Kulzer added a comment -

            We've discovered the issue we were experiencing with the Metacerberus output and wrote up our findings in IGBF-3924. Josh has provided us with sample output which we can use to create the documentation, here's the link to it on Google Drive: https://drive.google.com/drive/folders/14noPsmKYMxX9jgHYQhkjqaTGzT8z8bSK

            Basic outline:

            1. How to add a custom genome (using the lambda phage genome on Metacerberus' GitHub as an example: https://github.com/raw-lab/MetaCerberus/blob/main/lib/dependency_files/lambda-phage.fna)
            2. How to open files in IGB (local and remote)
            3. Caveat about Lambda_phage_sequences.gff files and how to fix the issue.
            Show
            pkulzer Paige Kulzer added a comment - We've discovered the issue we were experiencing with the Metacerberus output and wrote up our findings in IGBF-3924 . Josh has provided us with sample output which we can use to create the documentation, here's the link to it on Google Drive: https://drive.google.com/drive/folders/14noPsmKYMxX9jgHYQhkjqaTGzT8z8bSK Basic outline: How to add a custom genome (using the lambda phage genome on Metacerberus' GitHub as an example: https://github.com/raw-lab/MetaCerberus/blob/main/lib/dependency_files/lambda-phage.fna ) How to open files in IGB (local and remote) Caveat about Lambda_phage_sequences.gff files and how to fix the issue.
            pkulzer Paige Kulzer made changes -
            Sprint Fall 3 [ 204 ] Fall 4 [ 205 ]
            pkulzer Paige Kulzer made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            pkulzer Paige Kulzer made changes -
            Status In Progress [ 3 ] To-Do [ 10305 ]
            ann.loraine Ann Loraine made changes -
            Sprint Fall 4 [ 205 ] Fall 4, Fall 5 [ 205, 206 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            pkulzer Paige Kulzer made changes -
            Link This issue relates to IGBF-3927 [ IGBF-3927 ]
            pkulzer Paige Kulzer made changes -
            Link This issue relates to IGBF-3955 [ IGBF-3955 ]
            Hide
            pkulzer Paige Kulzer added a comment -

            I've created a MetaCerberus page within the IGB User's Guide (https://wiki.bioviz.org/confluence/display/igbman/MetaCerberus). I've also created IGB documentation for MetaCerberus' GitHub (https://drive.google.com/file/d/1lPyZ-dI4gSYOHrrygVY9R88KH7sCH2zk/view?usp=sharing).

            However, as a result of this ticket, we now know that both the GFF and GTF parsers need updating before MetaCerberus users can reliably visualize their output in IGB.

            Next steps:

            • Send IGB documentation to Josh to publish on GitHub.
            • Send Rick a summary of what we've learned and offer to meet with him to walk him through visualizing data in IGB.
            • Upgrade the GFF and GTF parsers, then update both sets of documentation to remove the caveat about ##FASTA sections.

            Nowlan Freese, any other next steps you can think of? If not, I will start working on these tasks and move this ticket to the backlog until we complete those blocker tickets.

            Show
            pkulzer Paige Kulzer added a comment - I've created a MetaCerberus page within the IGB User's Guide ( https://wiki.bioviz.org/confluence/display/igbman/MetaCerberus ). I've also created IGB documentation for MetaCerberus' GitHub ( https://drive.google.com/file/d/1lPyZ-dI4gSYOHrrygVY9R88KH7sCH2zk/view?usp=sharing ). However, as a result of this ticket, we now know that both the GFF and GTF parsers need updating before MetaCerberus users can reliably visualize their output in IGB. Next steps: Send IGB documentation to Josh to publish on GitHub. Send Rick a summary of what we've learned and offer to meet with him to walk him through visualizing data in IGB. Upgrade the GFF and GTF parsers, then update both sets of documentation to remove the caveat about ##FASTA sections. Nowlan Freese , any other next steps you can think of? If not, I will start working on these tasks and move this ticket to the backlog until we complete those blocker tickets.
            pkulzer Paige Kulzer made changes -
            Link This issue relates to IGBF-3927 [ IGBF-3927 ]
            pkulzer Paige Kulzer made changes -
            Link This issue is blocked by IGBF-3927 [ IGBF-3927 ]
            pkulzer Paige Kulzer made changes -
            Link This issue relates to IGBF-3955 [ IGBF-3955 ]
            pkulzer Paige Kulzer made changes -
            Link This issue is blocked by IGBF-3955 [ IGBF-3955 ]
            Hide
            pkulzer Paige Kulzer added a comment - - edited

            After chatting with Dr. Freese, I am going to make the following changes to our documentation and then close this ticket:

            • Be more verbose in my description of adding custom genomes to IGB (e.g., "The fasta file used with metacerberus will need to be added as the genome to IGB).
            • Add a second major heading for visualizing output in IGB, then make the others subheadings.
            • Add picture to final section of what the output will look like in IGB.
            • Add table of contents.
            Show
            pkulzer Paige Kulzer added a comment - - edited After chatting with Dr. Freese, I am going to make the following changes to our documentation and then close this ticket: Be more verbose in my description of adding custom genomes to IGB (e.g., "The fasta file used with metacerberus will need to be added as the genome to IGB). Add a second major heading for visualizing output in IGB, then make the others subheadings. Add picture to final section of what the output will look like in IGB. Add table of contents.
            pkulzer Paige Kulzer made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            pkulzer Paige Kulzer made changes -
            Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
            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 -
            Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
            pkulzer Paige Kulzer made changes -
            Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
            pkulzer Paige Kulzer made changes -
            Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
            pkulzer Paige Kulzer made changes -
            Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
            pkulzer Paige Kulzer made changes -
            Resolution Done [ 10000 ]
            Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]

              People

              • Assignee:
                pkulzer Paige Kulzer
                Reporter:
                pkulzer Paige Kulzer
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: