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

Create documentation for adding NCBI genomes to IGB Quickload

    Details

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

      Description

      Situation: We currently have documentation for adding new genomes to IGB Quickload using UCSC as a data source. However, after working hard on the IGB-UCSC integration, future requests for adding new genomes to IGB will have to be completed using other data sources such as NCBI. Since this is an entirely new data source and the process for downloading data and naming files will look different, we need to create some new documentation.

      Task:

      • Read over current documentation for adding new genomes to IGB Quickload (https://docs.google.com/document/d/1WQO_HWhpfUBntsNSaQ-jdrVoR6jJcQ7ewJ_HFvpYsYA/edit?usp=sharing).
      • Using our current documentation as a guide, create a new document in Google Drive, create section outlines, and transfer over as much relevant documentation as possible.
      • Include a section that discusses how to name files depending on the assembly type (e.g., "ncbiRefSeq" when dealing with a RefSeq assembly, "genBank" when dealing with a GenBank (GCA) assembly).
      • Include a section with an example annots.xml file that discusses how to format the description attribute depending on the assembly type (e.g., "NCBI GenBank [GenBank (GCA) assembly] [Assembly] ([Assembly date in MMM. DD, YYYY format])" when dealing with a GenBank (GCA) assembly), as well as the title attribute.
      • Include an example HEADER.md file that has been remade for genomes coming from NCBI rather than UCSC.
      • Include a section for creating species.txt and synonyms.txt.

        Attachments

          Issue Links

            Activity

            pkulzer Paige Kulzer (Inactive) created issue -
            pkulzer Paige Kulzer (Inactive) made changes -
            Field Original Value New Value
            Epic Link IGBF-1765 [ 17855 ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Status To-Do [ 10305 ] In Progress [ 3 ]
            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 ] Nowlan Freese [ nfreese ]
            pkulzer Paige Kulzer (Inactive) made changes -
            Link This issue relates to IGBF-4018 [ IGBF-4018 ]
            ann.loraine Ann Loraine made changes -
            Sprint Winter 1 [ 209 ] Winter 1, Spring 1 [ 209, 210 ]
            ann.loraine Ann Loraine made changes -
            Rank Ranked higher
            nfreese Nowlan Freese made changes -
            Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
            nfreese Nowlan Freese made changes -
            Assignee Nowlan Freese [ nfreese ] Paige Kulzer [ pkulzer ]
            nfreese Nowlan Freese 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:
                pkulzer Paige Kulzer (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: