.ig >>
<STYLE TYPE="text/css">
<!--
        A:link{text-decoration:none}
        A:visited{text-decoration:none}
        A:active{text-decoration:none}
        OL,UL,P,BODY,TD,TR,TH,FORM { font-family: arial,helvetica,sans-serif;; font-size:small; color: #333333; }

        H1 { font-size: x-large; font-family: arial,helvetica,sans-serif; }
        H2 { font-size: large; font-family: arial,helvetica,sans-serif; }
        H3 { font-size: medium; font-family: arial,helvetica,sans-serif; }
        H4 { font-size: small; font-family: arial,helvetica,sans-serif; }
-->
</STYLE>
<title>ploticus: vdist prefab</title>
<body bgcolor=D0D0EE vlink=0000FF>
<br>
<br>
<center>
<table cellpadding=2 bgcolor=FFFFFF width=550><tr>
<td>
  <table cellpadding=2 width=550><tr>
  <td><br><h2>vdist prefab</h2></td>
  <td align=right>
  <small>
  <a href="../doc/welcome.html"><img src="../doc/ploticus.gif" border=0></a><br>
  Version 2.33 Jun'06
     </small><br><a href="../doc/prefabs.html">Prefabs</a>
  <td></tr></table>
</td></tr>
<td>
<br>
<br>
.>>

.TH vdist_prefab PL "02-JUN-2006   PL ploticus.sourceforge.net"

.ig >>
<center><a href="prefab_vdist_ex.html">
<img src="../gallery/prefab_img/vdist1thm.gif" border=0> &nbsp;
<img src="../gallery/prefab_img/vdist3thm.gif" border=0>
 <br><b>View the vdist prefab examples</a></b><br><br></center>
.>>


.LP
\fBvdist\fR is a 
.ig >>
<a href="prefabs.html">
.>>
\0prefab
.ig >>
</a>
.>>
for displaying distributions of one or two variables.
Distributions may be depicted using histograms, bee-swarm diagrams, and/or rangebars.
Data do not need to be in any particular order.

.ig >>
<br><br><br>
.>>

.SH Parameters

.ig >>

<table cellpadding=2 bgcolor=A0A0A0 width=600>

<tr bgcolor=FFFFEC align=center><td><b>Prefab<br>parameter<br>name</td><td>Data type</td>
<td>Default</td><td>Description</td>
<td>Examples<br><small>(ignore line wrapping)</td></tr>


<tr bgcolor=FFFFFF>
<td><b><a href="prefab_stdparms.html">Standard parameters</a></td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td colspan=2>Most of the <a href="prefab_stdparms.html">standard prefab parameters</a> may be used.
You <font color=D00000>must specify</font> <b>data</b> (the name of an input data file)
(<b>data2</b> is also available for producing a second distribution, see below).
The X axis formatting parameters, legend parameters, and clickmap parameters aren't available
with this prefab.
<b>rectangle</b> controls the left plotting area.. the right plotting
area is automatically derived from the left one.  <b>ygrid</b> is on by default.. use
<tt>ygrid=no</tt> to turn off the grid.  <b>title</b> will be shown centered over the first 
distribution.. use <b>title2</b> to label the second distribution.  <b>ptselect</b> and 
<b>ptselect2</b> may be used to select different data rows for left and right side.
</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>y</td>
<td><a href="atypes.html#dfield">data field</a></td>
<td><font color=D00000>must be specified</font></td>
<td><nobr>Data field containing data for the first distribution.</nobr></td>
<td><tt>y=2<br><br>y=pmb</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>y2</td>
<td><a href="atypes.html#dfield">data field</a></td>
<td>&nbsp;</td>
<td>Data field containing data for the second (right panel) distribution.</td>
<td><tt>y2=4<br><br>y2=rmb</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>data2</td>
<td>filename <br>or<br><tt>-</tt></td>
<td>&nbsp;</td>
<td>Name of an optional second data file to get <b>y2</b> from.  
May be given as <tt>-</tt> to read data from standard input.
If not specified, it is assumed that both <b>y1</b> and <b>y2</b>
are coming from the same data file (<b>data</b>).</td>
<td><tt>data=file1  data2=file2  y=3  y2=3</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>title2</td>
<td>text</td>
<td>&nbsp;</td>
<td>A title to be displayed centered over the second distribution.</td>
<td><tt>"title2= Control Group"</td>
</tr>
</table>

<br>
<br>
<h2>Pertaining to the distribution histogram</h2>

<table cellpadding=2 bgcolor=A0A0A0 width=600>

<tr bgcolor=FFFFEC align=center><td><b>Prefab<br>parameter<br>name</td><td>Data type</td>
<td>Default</td><td>Description</td>
<td>Examples<br><small>(ignore line wrapping)</td></tr>


<tr bgcolor=FFFFFF>
<td><b>dist</b>
<td><tt>centered</tt><br><tt>histo</tt><br><tt>no</td>
<td><tt>centered</tt></td>
<td>Appearance of the distribution.  <tt>centered</tt> gives a beeswarm-like
display; <tt>histo</tt> gives a histogram.  May be specified as <tt>no</tt> to completely omit
the distribution portion and show rangebars (boxplots) only.</td>
<td><tt>dist=histo</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>bindiv</td>
<td>numeric</td>
<td>5.0</td>
<td>Control the bin size, based on Y axis stub increment.  
If specified, the bin size will be the stub increment divided by this value.
This can be a convenient way to control the bin size since the stub increment
is often automatically set, based on the data.</td>
<td><tt>bindiv=2</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>binsize</td>
<td>numeric</td>
<td>&nbsp;</td>
<td>Specify the bin size explicitly, for cases where the
automatically determined bin size isn't ideal.</td>
<td><tt>binsize=50</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>distcolor</td>
<td><a href="color.html">color</a></td>
<td><tt>blue</td>
<td>The color of the distribution histogram bars.</td>
<td><tt>distcolor=black</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>distdotspread</td>
<td>numeric</td>
<td>2.0</td>
<td>Distributions are made up of a series of dots; this parameter
controls how far apart (horizontally) the dots are rendered.
If you have lots of dots and they are extending
too far horizontally, reduce this value; for the opposite effect increase this value.</td>
<td><tt>distdotspread=1.5</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>distdotshape</td>
<td><tt> circle <br> square <br> diamond <br> triangle </td>
<td><tt>diamond</td>
<td>The shape of the individual dots.</td>
<td><tt>distdotshape=square</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>distdotsize</td>
<td><a href="atypes.html#punits">inches or cm</a></td>
<td>0.04 "</td>
<td>The radius of the individual data point dots. </td>
<td><tt>distdotsize=0.025</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>distcenter</td>
<td>0 to 10</td>
<td>4</td>
<td>When doing a centered (beeswarm) display, controls the location of the center
of the display in X, using a data space ranging from 0 to 10.</td>
<td><tt>distcenter=3</td>
</tr>
</table>

<br>
<br>


<h2>Pertaining to the rangebars (boxplots)</h2>

<table cellpadding=2 bgcolor=A0A0A0 width=600>

<tr bgcolor=FFFFEC align=center><td><b>Prefab<br>parameter<br>name</td><td>Data type</td>
<td>Default</td><td>Description</td>
<td>Examples<br><small>(ignore line wrapping)</td></tr>


<tr bgcolor=FFFFFF>
<td><b>rangebar</td>
<td><tt>yes </tt>or<tt>no</td>
<td><tt>yes</td>
<td>Controls the rangebar portion of the display.  May be specified as </tt>no</tt>
to completely omit the rangebar portion and show distributions only.</td>
<td><tt>rangebar=no</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>barcolor</td>
<td><a href="color.html">color</a></td>
<td><tt>dullyellow</td>
<td>Color of the interior of the rangebar.</td>
<td><tt>barcolor=pink</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>barwidth</td>
<td><a href="atypes.html#punits">inches or cm</a></td>
<td>0.2 "</td>
<td>Width of the rangebar.</td>
<td><tt>barwidth=0.12</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>mediansym</td>
<td><tt>dot</tt><br>or<br><tt>line</tt><br>or<br><a href="symboldetails.html">smboldetails</a></td>
<td><tt>line</td>
<td>
Symbol for representing the median.  By default a <tt>line</tt> segment is used.
Use <tt>dot</tt> to get a small black dot, or specify a different data point symbol.</td>
<td><tt>mediansym=dot</td>
</tr>

<tr bgcolor=FFFFFF>
<td><b>showoutliers</td>
<td><tt>yes</tt><br>or<br><tt>no</td>
<td><tt>no</td>
<td>If <tt>yes</tt>, show outlier data points (points lying beyond the tails).
The normal way of showing outliers is by short line segments, but data point symbols
can be specified (<b>outliernearsym</b>, <b>outlierfarsym</b>).
If <b>id</b> is specified, the outliers will be labelled.</td>
<td><tt>showoutliers=yes</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>id <br><br>id2</td>
<td><a href="atypes.html#dfield">datafield</a></td>
<td>&nbsp;</td>
<td>A data field containing identifier strings.  If specified, and if outliers
are being displayed in the rangebar (boxplot) portion of the display, these identifier
strings will be used to identify outlier data points.  Similarly, <b>id2</b>
may be used with the second (right panel) distribution.</td>
<td><tt>id=5</td>
</tr>


<tr bgcolor=FFFFFF>
<td><b>rangebarcenter</td>
<td>0 to 10</td>
<td>&nbsp;</td>
<td>Controls the location of the center
of the rangebar in X, using a data space ranging from 0 to 10.  
The default location is at X=8, or if rangebars alone are being displayed, at X=3.</td>
<td><tt>rangebarcenter=6</td>
</tr>

<tr bgcolor=FFFFEC><td colspan=5>
<h3>Additional parameters</h3>
The following parameters are available for the rangebar/boxplot, and are exactly as described in the 
<a href="rangebar.html">proc rangebar manual page</a> .. see that page for descriptions 
and usage.  All are optional.
<p>
<b>outlierlinelen</b> &nbsp; length of the outlier line segments
<p>
<b>tailmode</b> &nbsp; modes for what the tails represent
<p>
<b>95tics</b> &nbsp; add tics to show 5th and 95th percentiles
<p>
<b>taildetails</b> &nbsp; appearance details for tails
<p>
<b>outline</b> &nbsp; outline the bars
<p>
<b>outliernearsym</b> &nbsp; symbol for "near" outliers
<p>
<b>outlierfarsym</b> &nbsp; symbol for "far" outliers
<p>
<b>outliernearfarcutoff</b> &nbsp; cutoff determining when an outlier is near vs. far

</td></tr>
</table>
<br>
<br>
.>>



.ig >>
<br>
<br>
</td></tr>
<td align=right>
<a href="../doc/welcome.html">
<img src="../doc/ploticus.gif" border=0></a><br><small>data display engine &nbsp; <br>
<a href="../doc/Copyright.html">Copyright Steve Grubb</a>
<br>
<br>
<center>
<img src="../gallery/all.gif"> 
</center>
</td></tr>
</table>
<br>
<center>
Ploticus is hosted at http://ploticus.sourceforge.net <br>
<img src="http://sourceforge.net/sflogo.php?group_id=38453" width="88" height="31" border="0" alt="SourceForge Logo">
</center>
.>>
