QA Track Checklist

From Genecats
Jump to navigationJump to search

This page is will include an updated track QA procedure adapted from the previous page (http://genomewiki.ucsc.edu/genecats/index.php/New_track_checklist) as well as others, and include new approaches, settings, and focus. The page should have a focus on track improvement, more than just bug testing. This requires some familiarity with the data at play, trackDb options, and customizing the GB display.

Notes

QA met on May 12, 2021 in order to brainstorm additions to this page. Below are the notes from that meeting, which will get incorporated into this page.

  • Familiarity with the data. This includes reading abstracts, resource website, or manuscripts if needed. The goal is to understand the data enough to find meaning when looking at it in the Genome Browser.
    • Check the data's native data portal (if one exists) or even their own genome browsers, such as decipher or gnomAD. Import features or similarities from how they are displayed in their native source
    • Keep in mind how colors, mouseOvers, linkouts, etc. could be improved
  • Review docs - engineers are responsible for at least initial drafts
    • Desc pages for all tracks
    • Document new trackDb variables in definition doc
  • What trackDb settings should we keep in mind to better a track:
    • Filters
    • mouseOver
    • mergeSpannedItems / hideEmptySubtracks
    • ???
  • Check the .js console for UI changes, or chages affecting javaScript (more feature QA)
  • Check error logs on dev when QA'ing new track and data
  • Archiving/versioning - start discussion during track development/QA
  • Consider if any tracks should be added should be related through Related Tracks feature
  • Track searching, is it working
  • Focus on shortLabel and longLabel, are they concise and descriptive, could they be improved?
  • Use dataCheck script, look for item chrom coverage
  • Simplify QA process when track is of established track type
    • Skip other CGI steps when typical bigBed/bigWig