Documented the EXAMINE subcommands. Fixed up the examine test. Fixed a problem...

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

diff --git a/doc/statistics.texi b/doc/statistics.texi
index 29e8f0646accf33ff418c65d9e5e13ef82fcdedf..19fe6d5abcab12f21db907760203f97999fda7b8 100644 (file)
--- a/doc/statistics.texi
+++ b/doc/statistics.texi
@@ -4,12 +4,16 @@
 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.
+* EXAMINE::                     Testing data for normality.
 * CROSSTABS::                   Crosstabulation tables.
 * T-TEST::                      Test hypotheses about means.
-* ONEWAY::                      One analysis of variance.
+* ONEWAY::                      One way analysis of variance.
 @end menu
 
 @node DESCRIPTIVES, FREQUENCIES, Statistics, Statistics
@@ -102,7 +106,7 @@ in the order that they are specified on the VARIABLES subcommand.  The A
 and D settings request an ascending or descending sort order,
 respectively.
 
-@node FREQUENCIES, CROSSTABS, DESCRIPTIVES, Statistics
+@node FREQUENCIES, EXAMINE, DESCRIPTIVES, Statistics
 @section FREQUENCIES
 
 @vindex FREQUENCIES
@@ -209,7 +213,67 @@ boundaries of the data set divided into the specified number of ranges.
 For instance, @code{/NTILES=4} would cause quartiles to be reported.
 
 
-@node CROSSTABS, T-TEST, FREQUENCIES, Statistics
+@node EXAMINE, CROSSTABS, FREQUENCIES, Statistics
+@comment  node-name,  next,  previous,  up
+@section EXAMINE
+@vindex EXAMINE
+
+@cindex Normality, testing for
+
+@display
+EXAMINE
+        VARIABLES=var_list [BY factor_list ]
+        /STATISTICS=@{DESCRIPTIVES, EXTREME[(n)], ALL, NONE@}
+        /PLOT=@{STEMLEAF, BOXPLOT, NPPLOT, SPREADLEVEL(n), HISTOGRAM, 
+              ALL, NONE@}
+        /CINTERVAL n
+        /COMPARE=@{GROUPS,VARIABLES@}
+        /ID=@{case_number, var_name@}
+        /@{TOTAL,NOTOTAL@}
+        /MISSING=@{LISTWISE, PAIRWISE@} [@{EXCLUDE, INCLUDE@}] 
+               [@{NOREPORT,REPORT@}]
+
+@end display
+
+The @cmd{EXAMINE} command is used to test how closely a distribution is to a 
+normal distribution.  It also shows you outliers and extreme values.
+
+The VARIABLES subcommand specifies the dependent variables and the
+independent variable to use as factors for the analysis.   Variables
+listed before the first BY keyword are the dependent variables.
+The dependent variables may optionally be followed by a list of
+factors which tell PSPP how to break down the analysis for each
+dependent variable.  The format for each factor is 
+@display
+var [BY var].
+@end display
+
+
+The STATISTICS subcommand specifies the analysis to be done.  
+DESCRIPTIVES will produce a table showing some parametric and
+non-parametrics statistics.  EXTREME produces a table showing extreme
+values of the dependent variable.  A number in parentheses determines
+how many upper and lower extremes to show.  The default number is 5.
+
+
+The PLOT subcommand specifies which plots are to be produced if any.
+
+The CINTERVAL subcommand specifies the confidence interval to use in
+calculation of the descriptives command.  The default it 95%.
+
+The TOTAL and NOTOTAL subcommands are mutually exclusive.  If NOTOTAL
+is given and factors have been specified in the VARIABLES subcommand,
+then then statistics for the unfactored dependent variables are
+produced in addition to the factored variables.  If there are no
+factors specified then TOTAL and NOTOTAL have no effect.
+
+@strong{Warning!}
+If many dependent variable are given, or factors are given for which
+there are many distinct values, then @cmd{EXAMINE} will produce a very
+large quantity of output.
+
+
+@node CROSSTABS, T-TEST, EXAMINE, Statistics
 @section CROSSTABS
 
 @vindex CROSSTABS