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

Improve documentation description quickload files for painted lady genome assembly

    Details

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

      Description

      We are offering a genome assembly for painted lady as part of our Quickload site - see: http://igbquickload-main.bioviz.org/quickload/V_cardui_Feb_2021/

      However, the in the HEADER file (see above link) does not have enough information for a user to locate the original files we used to create our IGB-friendly versions of the files. This can become a problem for users who are working with bioinformatics pipelines that use assembly or annotation files. They will need to know if the files we are showing in IGB are the same as the files they are working with, or not.

      Also, it would be good to link to a research article describing this assembly, to help users learn more about this assembly.

      For this task, improve the documentation so that a user who clicks the "get info" link within IGB will be able to find information needed to locate the original data files we used to create our IGB-friendly versions for the Quickload repository.

      Notes:

        Attachments

        1. HEADER.md
          1 kB
          Paige Kulzer
        2. HEADER_V2.md
          1 kB
          Paige Kulzer

          Issue Links

            Activity

            Hide
            ann.loraine Ann Loraine added a comment -

            Thank you for your patience with my many questions.
            How about if I make a stab at updating the documentation?
            Then you can see if I got it right or not, and correct as needed?

            Show
            ann.loraine Ann Loraine added a comment - Thank you for your patience with my many questions. How about if I make a stab at updating the documentation? Then you can see if I got it right or not, and correct as needed?
            Hide
            ann.loraine Ann Loraine added a comment - - edited

            New documentation page is deployed to IGB quickload sites and ready for testing.
            See: https://data.bioviz.org/quickload/D_dama_Nov_2023/

            Show
            ann.loraine Ann Loraine added a comment - - edited New documentation page is deployed to IGB quickload sites and ready for testing. See: https://data.bioviz.org/quickload/D_dama_Nov_2023/
            Hide
            pkulzer Paige Kulzer added a comment - - edited

            Question for Ann Loraine - Did you forget to link to the research article describing this Dama dama assembly (see https://www.sciencedirect.com/science/article/pii/S2666937423000124#da0005)?

            Show
            pkulzer Paige Kulzer added a comment - - edited Question for Ann Loraine - Did you forget to link to the research article describing this Dama dama assembly (see https://www.sciencedirect.com/science/article/pii/S2666937423000124#da0005)?
            Hide
            pkulzer Paige Kulzer added a comment - - edited

            I've added mention of the research article I mentioned in my previous comment. This update has been pushed to the SVN repository which is now at revision 228. This new documentation format is clear, concise, and easy to follow. Ready for a final review by Ann Loraine!

            Show
            pkulzer Paige Kulzer added a comment - - edited I've added mention of the research article I mentioned in my previous comment. This update has been pushed to the SVN repository which is now at revision 228. This new documentation format is clear, concise, and easy to follow. Ready for a final review by Ann Loraine !
            Hide
            ann.loraine Ann Loraine added a comment - - edited

            Our quickload sites are now updated to revision 228. New documentation is deployed. I checked all the links and they all go to the expected location.

            Moving to Done.

            Show
            ann.loraine Ann Loraine added a comment - - edited Our quickload sites are now updated to revision 228. New documentation is deployed. I checked all the links and they all go to the expected location. Moving to Done.

              People

              • Assignee:
                pkulzer Paige Kulzer
                Reporter:
                ann.loraine Ann Loraine
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: