* statistics.texi: Document charts supported by FREQUENCIES.

[pspp-builds.git] / doc / statistics.texi

diff --git a/doc/statistics.texi b/doc/statistics.texi
index 8d5971da1c04ae25116566f25682636fb69f882d..0774d526d70653fbac37c0dbf2c416c763d76972 100644 (file)
--- a/doc/statistics.texi
+++ b/doc/statistics.texi
@@ -4,9 +4,6 @@
 This chapter documents the statistical procedures that PSPP supports so
 far.
 
-@c If you add any new commands, then don't forget to remove the entry in 
-@c not-implemented.texi
-
 @menu
 * DESCRIPTIVES::                Descriptive statistics.
 * FREQUENCIES::                 Frequency tables.
@@ -127,10 +124,12 @@ FREQUENCIES
                      SESKEWNESS,SEKURTOSIS,ALL,NONE@}
         /NTILES=ntiles
         /PERCENTILES=percent@dots{}
+        /HISTOGRAM=[MINIMUM(x_min)] [MAXIMUM(x_max)] 
+                   [@{FREQ,PCNT@}] [@{NONORMAL,NORMAL@}]
+        /PIECHART=[MINIMUM(x_min)] [MAXIMUM(x_max)] @{NOMISSING,MISSING@}
 
 (These options are not currently implemented.)
         /BARCHART=@dots{}
-        /HISTOGRAM=@dots{}
         /HBAR=@dots{}
         /GROUPED=@dots{}
 
@@ -143,9 +142,9 @@ variables.
 @cmd{FREQUENCIES} can also calculate and display descriptive statistics
 (including median and mode) and percentiles.
 
-In the future, @cmd{FREQUENCIES} will also support graphical output in the
-form of bar charts and histograms.  In addition, it will be able to
-support percentiles for grouped data.
+@cmd{FREQUENCIES} also support graphical output in the form of
+histograms and pie charts.  In the future, it will be able to produce
+bar charts and output percentiles for grouped data.
 
 The VARIABLES subcommand is the only required subcommand.  Specify the
 variables to be analyzed.  In most cases, this is all that is required.
@@ -207,6 +206,7 @@ value, and MODE, the mode.  (If there are multiple modes, the smallest
 value is reported.)  By default, the mean, standard deviation of the
 mean, minimum, and maximum are reported for each variable.
 
+@cindex percentiles
 PERCENTILES causes the specified percentiles to be reported.
 The percentiles should  be presented at a list of numbers between 0
 and 100 inclusive.  
@@ -214,6 +214,20 @@ The NTILES subcommand causes the percentiles to be reported at the
 boundaries of the data set divided into the specified number of ranges.
 For instance, @code{/NTILES=4} would cause quartiles to be reported.
 
+The HISTOGRAM subcommand causes the output to include a histogram for
+each specified variable.  The X axis by default ranges from the
+minimum to the maximum value observed in the data, but the MINIMUM and
+MAXIMUM keywords can set an explicit range.  The Y axis by default is
+labeled in frequencies; use the PERCENT keyword to causes it to be
+labeled in percent of the total observed count.  Specify NORMAL to
+superimpose a normal curve on the histogram.
+
+The PIECHART adds a pie chart for each variable to the data.  Each
+slice represents one value, with the size of the slice proportional to
+the value's frequency.  By default, all non-missing values are given
+slices.  The MINIMUM and MAXIMUM keywords can be used to limit the
+displayed slices to a given range of values.  The MISSING keyword adds
+slices for missing values.
 
 @node EXAMINE, CROSSTABS, FREQUENCIES, Statistics
 @comment  node-name,  next,  previous,  up
@@ -272,6 +286,7 @@ If the /COMPARE subcommand is ommitted, then PSPP uses the default value of
 The CINTERVAL subcommand specifies the confidence interval to use in
 calculation of the descriptives command.  The default it 95%.
 
+@cindex percentiles
 The PERCENTILES subcommand specifies which percentiles are to be calculated, 
 and which algorithm to use for calculating them.  The default is to
 calculate the 5, 10, 25, 50, 75, 90, 95 percentiles using the
@@ -414,6 +429,9 @@ The STATISTICS subcommand selects statistics for computation:
 
 @table @asis
 @item CHISQ
+@cindex chisquare
+@cindex chi-square
+
 Pearson chi-square, likelihood ratio, Fisher's exact test, continuity
 correction, linear-by-linear association.
 @item PHI
@@ -655,8 +673,6 @@ to specify different contrast tests.
 @section RANK
 
 @vindex RANK
-@cindex RANK
-
 @display
 RANK
         [VARIABLES=] var_list [@{A,D@}] [BY var_list]