src/utils/wigAsciiToBinary/wiggleFAQ.html 1.3

1.3 2009/11/25 18:52:08 hiram
change autoScaleDefault to be only autoScale
Index: src/utils/wigAsciiToBinary/wiggleFAQ.html
===================================================================
RCS file: /projects/compbio/cvsroot/kent/src/utils/wigAsciiToBinary/wiggleFAQ.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -b -B -U 1000000 -r1.2 -r1.3
--- src/utils/wigAsciiToBinary/wiggleFAQ.html	25 Nov 2009 18:31:29 -0000	1.2
+++ src/utils/wigAsciiToBinary/wiggleFAQ.html	25 Nov 2009 18:52:08 -0000	1.3
@@ -1,120 +1,120 @@
 <HTML><HEAD><TITLE> WIGGLE Track FAQ </TITLE>
 <BODY>
 <PRE>
 To create a wiggle track, generate two column ascii data files
 for each chromosome (chrN) and keep them gzipped.  The two columns are:
 
 &lt;chrom position (1 relative)&gt;    &lt;real data value&gt;
 
 To load that data into a track:
 
 zcat &lt;one of those files for chrN&gt; | \
     wigAsciiToBinary -chrom=&lt;chrN&gt; -wibFile=&lt;chrN&gt;_&lt;trackName&gt; stdin
 
 That creates two files:  &lt;chrN&gt;_&lt;trackName&gt;.wig and &lt;chrN&gt;_&lt;trackName&gt;.wib
 the .wig file are the table row entries.  The .wib is the data compressed
 to single bytes.  Symlink the .wib files
 from /gbdb/&lt;db&gt;/wib/&lt;chrN&gt;_&lt;trackName&gt;.wib -&gt; to your .wib file.
 This program will display one information line, your data range limits.
 You want this later for your trackDb.ra entry.
 
 Load all the .wig files into trackName on a db:
 
 hgLoadWiggle &lt;db&gt; &lt;trackName&gt; &lt;chr*&gt;_&lt;trackName&gt;.wig
 ln -s `pwd`/*.wib  /gbdb/&lt;db&gt;/wib/
 
 Your trackDb entry is, eg:
 
 track &lt;trackName&gt;
 shortLabel &lt;short label&gt;
 longLabel &lt;long label&gt;
 group x
 priority 1106
 visibility full
-autoScaleDefault Off
+autoScale Off
 maxHeightPixels 128:36:16
 graphTypeDefault Bar
 gridDefault OFF
 viewLimits 0.0:0.01
 color 0,128,255
 altColor 255,128,0
 type wig -0.0732 0.153
 
 Your data range limits are used in the "type wig &lt;lower&gt; &lt;upper&gt;"
 line.
 You want overall limits for all chromosomes, this will properly
 limit the data view limits available to users on the trackUI page.
 
 The option viewLimits can specify an initial viewing window
 on the data within the range specified on the "type wig" line.
 The format is "viewLimits &lt;lower&gt;:&lt;upper&gt;"
 
-Auto scaling is on by default, use the "autoScaleDefault Off" trackDb entry
+Auto scaling is on by default, use the "autoScale Off" trackDb entry
 to turn that off by default.
 
 The maxHeightPixels specifies the maximum:default:minimum
 allowed user requested size for the track.  The "default" specification
 is for the initial height of the graph.  The user can select anything
 between the "maximum" and "minimum" sizes.  If this option is not
 present in the trackDb entry, the default is 128:128:11
 
 Default graph type is a Bar graph.  You can specify a line graph (points)
 for an initial graph type with the presence of "graphTypeDefault Points"
 
 Default is off for the grid lines.  (currently only y=0.0)
 You can turn them on with "gridDefault ON"
 
 <TABLE BORDER=1 ALIGN=CENTER>
 <TR><TH ALIGN=CENTER COLSPAN=2> trackDB option summary </TH></TR>
-<TR><TH ALIGN=LEFT> autoScaleDefault </TH><TD> [Use Vertical Viewing Range Setting|Auto-Scale to data view] default Use Vertical Viewing Range Setting</TD></TR>
+<TR><TH ALIGN=LEFT> autoScale </TH><TD> [Use Vertical Viewing Range Setting|Auto-Scale to data view] default Use Vertical Viewing Range Setting</TD></TR>
 <TR><TH ALIGN=LEFT> maxHeightPixels </TH><TD> &lt;max:default:min&gt; default &lt;128:128:11&gt;</TD></TR>
 <TR><TH ALIGN=LEFT> graphTypeDefault </TH><TD> [Bar|Points] default Bar</TD></TR>
 <TR><TH ALIGN=LEFT> gridDefault </TH><TD> [ON|OFF] default OFF (draws y=0.0 line when ON)</TD></TR>
 <TR><TH ALIGN=LEFT> viewLimits </TH><TD> &lt;lower:upper&gt; default from the type wig line</TD></TR>
 <TR><TH ALIGN=LEFT> yLineMark </TH><TD> &lt;value&gt; default is 0.0</TD></TR>
 <TR><TH ALIGN=LEFT> yLineOnOff </TH><TD> [ON|OFF] default OFF</TD></TR>
 <TR><TH ALIGN=LEFT> windowingFunction </TH><TD> [Maximum|Mean|Minimum] default Maximum</TD></TR>
 <TR><TH ALIGN=LEFT> smoothingWindow </TH><TD> [OFF|2-16] default OFF</TD></TR>
 </TABLE>
 
 
 If your data is for every N bases instead of every base, then
 use the -dataSpan=N option on the wigAsciiToBinary operation.
 
 Any real valued data can be used.
 Positions can be "lifted" when necessary.  Note the -offset=N option
 to wigAsciiToBinary.
 Any type of holes in the data are allowed.
 
 TO BE DONE:  smoothing of data display, more horizontal grid lines
 	than just y = 0.0, dense track gray scale can be more dynamic.
 
 FEATURE REQUESTS: Colorize or somehow indicate named
 	features  (will be needed on the multiple alignment tracks for the
 	different alignment blocks), separate items can also become
 	individual graphs within a much larger track
 
 PLEASE ADVISE: <A HREF="mailto:&#104;&#105;r&#97;&#109;&#64;&#115;&#111;&#101;.&#117;cs&#99;.&#101;&#100;&#117;">&#104;&#105;r&#97;&#109;&#64;&#115;&#111;&#101;.&#117;cs&#99;.&#101;&#100;&#117;</A>
 	for any feature requests, thanks.
 
 wigAsciiToBinary - convert ascii Wiggle data to binary file
 usage: wigAsciiToBinary [-offset=N] [-binsize=N] [-dataSpan=N] \
         [-chrom=chrN] [-wibFile=<file name>] [-name=<feature name>] \
         [-verbose] <two column ascii data file names>
         -offset=N - add N to all coordinates, default 0
         -binsize=N - # of points per database row entry, default 1024
         -dataSpan=N - # of bases spanned for each data point, default 1
         -chrom=chrN - this data is for chrN
         -wibFile=chrN - to name the .wib output file
         -name=<feature name> - to name the feature, default chrN or
                 -chrom specified
         -verbose - display process while underway
         <file names> - list of files to process
 If the name of the input files are of the form: chrN.<....> this will
         set the output file names.  Otherwise use the -wibFile option.
 Each ascii file is a two column file.  Whitespace separator
 First column of data is a chromosome location (IN NUMERICAL ORDER !).
 Second column is data value for that location, any real data value allowed.
 
 </PRE>
 </BODY></HTML>