src/hg/makeDb/trackDb/README 1.102
1.102 2010/03/13 01:31:53 rhead
Added notes about release public.
Index: src/hg/makeDb/trackDb/README
===================================================================
RCS file: /projects/compbio/cvsroot/kent/src/hg/makeDb/trackDb/README,v
retrieving revision 1.101
retrieving revision 1.102
diff -b -B -U 4 -r1.101 -r1.102
--- src/hg/makeDb/trackDb/README 16 Feb 2010 20:23:54 -0000 1.101
+++ src/hg/makeDb/trackDb/README 13 Mar 2010 01:31:53 -0000 1.102
@@ -39,9 +39,9 @@
your personal copy (on hgwdev-userName) do
make update
to do it on genome-test do
make alpha
-You can also restrict a track to alpha or beta using
+You can also restrict a track to alpha, beta, or public
by using the release field.
THE TRACK FIELD
@@ -423,23 +423,33 @@
o dataVersion - prints out as the Data version on the details page
(used chiefly by ENCODE)
o origAssembly - prints out a message on the details page, indicating
that the data was lifted from this assembly (used chiefly by ENCODE)
- o release <alpha | beta> - restricts inclusion of a trackDb entry
- in the database. TrackDb entries marked 'release beta' are
- included in the trackDb database when 'make beta'
- (or 'make strict') are used to create it. Those marked
- 'release alpha' are included when 'make alpha' (or 'make')
- is used. This setting is used to avoid inadvertently changing
- the configuration of an existing public track when it is
- undergoing further development. It provides a temporary
- development-only version of the trackDb. In this situation,
- the developer should mark the existing trackDb entry (as on
- the public server) 'release beta', and then add a parallel
- entry marked 'release alpha' (the development version).
+ o release <alpha | beta | public> - restricts inclusion of a trackDb entry
+ in the database.
+ - Tracks marked 'release alpha' are included when 'make alpha' (or 'make')
+ is used. The alpha setting is used to avoid inadvertently changing the
+ configuration of an existing public track when it is undergoing further
+ development. It provides a temporary development-only version of the
+ trackDb.
+ - TrackDb.ra entries marked 'release beta' are included in the trackDb
+ table with 'make beta'. This setting is for tracks that are staged for
+ release by Q/A.
+ - Entries marked 'release public' are included with 'make public'. The
+ public setting marks tracks that are already published or are about to
+ be published.
+ - Entries marked 'release alpha,beta,public' have the same behavior as
+ those with no release tag.
+ To initiate changes to an existing public track, a developer should
+ mark the existing trackDb entry (the public server version) with the
+ 'release beta,public' tag, and then add a parallel entry marked
+ 'release alpha' (the development version).
The existence of two entries should be noted in the pushQ.
- Q/A will retire the duplicate entry and remove the release
- labels when the track is published.
+ Q/A will stage the track for release by changing the development
+ version to 'release alpha,beta' and the public version 'release public'.
+ When the track is published, Q/A will collapse the two entries and
+ remove all release labels. More information is here:
+ http://genomewiki.cse.ucsc.edu/index.php/ThreeStateTrackDb
o html - specifies alternate filename for track description. Should only
be used when updating an existing track (used chiefly by ENCODE).
in conjunction with the 'release alpha' setting.
o scoreMin, scoreMax - sets the range used to color the track if