Creating a pushQ Entry: Difference between revisions

From Genecats
Jump to navigationJump to search
(redmine)
No edit summary
Line 1: Line 1:
After you have finished creating a track and it is ready for QA, you should add an entry to the qapushq table on hgwbeta.
This page is for documenting the process of creating/updating a pushQ entry. For the entire hand-off of a Track from Developers to QAers, see the redmine wiki page [http://redmine.soe.ucsc.edu/projects/genomebrowser/wiki/Track here].
There is a [http://hgwbeta.cse.ucsc.edu/cgi-bin/qaPushQ CGI] for this.
 
After you have finished creating a track and it is ready for QA, you should add an entry to the qapushq table on hgwbeta. There is a [http://hgwbeta.cse.ucsc.edu/cgi-bin/qaPushQ CGI] for this.


'''Add a track to the pushQ only if everything is ready.'''   
'''Add a track to the pushQ only if everything is ready.'''   
Line 17: Line 18:


''PRIORITY:''
''PRIORITY:''
Leave set to A.
Leave this set to A.


''IMPORTANCE:''
''IMPORTANCE:''
Line 29: Line 30:


''RELEASE LOG:''
''RELEASE LOG:''
Generally you should put the track shortLabel followed by comments in parentheses, if any (e.g. Known Gene (data update)).  No need to enter the database name.  This text will appear in the [http://genome.ucsc.edu/goldenPath/releaseLog.html Release Log].
Generally you should put the track shortLabel followed by comments in parentheses, if any (e.g. UCSC Genes (data update)).  No need to enter the database name.  This text will appear in the [http://genome.ucsc.edu/goldenPath/releaseLog.html Release Log].


''RELEASE LOG URL''
''RELEASE LOG URL''
Line 42: Line 43:


''CGIs:''  
''CGIs:''  
If this track depends on a particular upcoming release of the CGIs, enter the CGI name and the version number here (e.g. hgTracks (v250)).
Leave this blank in favor of completing it in the corresponding redmine issue.


''FILES:''
''FILES:''
Line 80: Line 81:


''EXTERNAL SOURCE:''  
''EXTERNAL SOURCE:''  
If applicable, enter the name and email address of the collaborator, or enter a website or lab where the data came from.
Leave this blank in favor of completing it in the corresponding redmine issue.
 


''OPEN ISSUES:''
''OPEN ISSUES:''
Generally leave blank.  Put any known issues with the track in redmine.
Generally leave blank.  Put any known issues with the track in the corresponding redmine issue.


''NOTES:''
''NOTES:''
Put a link to the associated redmine issue here.  In the redmine ticket, add:
Enter the number of the corresponding redmine issue.
 
* The '''redmine''' number that is related to this track.
 
* The '''name of one or more related tracks''' for QA to compare/contrast with the new track, and how you expect they would relate.  (For instance, should they have essentially the same footprint on the genome, or complement one another, or cover more or less of the genome?)  We will be running [[New_track_checklist#FeatureBits_and_Gaps | featureBits -enrichment]] to compare the tracks and will need to make a judgment call about whether the new track seems reasonable.
 
* Any notes you think might be helpful to the QA team.  Be as specific as possible -- the more you say, the less QA will have to ask you.
 
* If this track has been requested by a user, add a note with the user's email address and a link to the redmine MLQ ticket, if there is one.  QA will send an email to that user after the track has been pushed to the RR.
 
* If this track is replacing an existing track, list the tables/files to drop.
 
<hr>
After the track has been QAed and pushed to the public website, you can edit the original tables and files on genome-test as you like.  This new data will not be QAed and pushed until you add another pushQ entry. If you edit the trackDb entry, though, be sure to use [http://genomewiki.ucsc.edu/index.php/ThreeStateTrackDb#Updated_trackDb_release_process release tags]!!!
 
<hr>
If this is the release of an entire assembly, use Angie's [[makePushQSql.pl]] script.


[[Category:Browser QA]]
[[Category:Browser QA]]
[[Category:Browser QA dev handoff]]
[[Category:Browser QA dev handoff]]

Revision as of 21:46, 11 December 2012

This page is for documenting the process of creating/updating a pushQ entry. For the entire hand-off of a Track from Developers to QAers, see the redmine wiki page here.

After you have finished creating a track and it is ready for QA, you should add an entry to the qapushq table on hgwbeta. There is a CGI for this.

Add a track to the pushQ only if everything is ready. This includes:

  • All tables have been built.
  • TrackDb has been edited (including search stanzas). If this is an update to an existing track, you may need to use release tags.
  • Make alpha on hgwdev in src/hg/makeDb/trackDb directory.
  • All underlying files are complete and in the correct location (usually /gbdb/).
  • All associated downloads files have been created and are in the correct location (usually /usr/local/apache/htdocs-hgdownload/goldenPath/), and accompanying README.txt and md5sum.txt files are present.
  • html text for details page is complete (see also description pages and citation formats) and is in highest logical level for the assembly. If this is an update to an existing track, you may need to make the updated details page visible on alpha while the original page is visible on beta and public. This can be achieved with release tags and an html qualifier in the alpha stanza.
  • All tables have been added to the all.joiner file.
  • Data contributor (if any) has approved of the track display.

Editing the pushQ entry:

PRIORITY: Leave this set to A.

IMPORTANCE: Leave set to Unprioritized.

NEW TRACK?: If this same track exists on this or another assembly, or this is an addition to an existing track, leave this set to N. If this is a brand new track set this to Y. If this isn't a track at all, set this to X.

TRACK: Put an identifier for the track here. This is often the shortLabel.

RELEASE LOG: Generally you should put the track shortLabel followed by comments in parentheses, if any (e.g. UCSC Genes (data update)). No need to enter the database name. This text will appear in the Release Log.

RELEASE LOG URL If you would like the Release Log entry for this track to link to the track description page, then enter a relative link to it here, e.g.: 

../../cgi-bin/hgTrackUi?db=hg18&g=wgEncodeBuOrchid

DATABASES: List the database(s) where your table(s) are located (e.g. hg19, hgFixed).

TABLES: List all tables that should be pushed. Don't forget to include extFile and seq if your track uses them.

CGIs: Leave this blank in favor of completing it in the corresponding redmine issue.

FILES: List all files that should be pushed. Don't forget to include:

  • gbdb files
  • download files

SIZE: Press the Show Sizes button. All tables and files should be found without errors (if they are not, you probably have entered a path incorrectly or have a typo in the lists). Scroll to the bottom of the page and click the "Set Size as ..." link.

CURRENT LOCATION: Set to hgwdev.

MAKEDOC VERIFIED: Leave this set to N.

ONLINE HELP: This is generally an unused field.

INDEX VERIFIED: Leave this set to N.

ALL.JOINER VERIFIED: Leave this set to N.

STATUS: Leave blank.

FEATUREBITS: Leave blank.

SPONSOR (LOCAL): Enter your first name, or your username, in lower-case letters. Whatever name you decide to use, be consistent among tracks.

REVIEWER: Leave blank.

EXTERNAL SOURCE: Leave this blank in favor of completing it in the corresponding redmine issue.


OPEN ISSUES: Generally leave blank. Put any known issues with the track in the corresponding redmine issue.

NOTES: Enter the number of the corresponding redmine issue.

Retrieved from "https://genomewiki.ucsc.edu/genecats/index.php?title=Creating_a_pushQ_Entry&oldid=1378"