Correct typo in documentation of SAVE TRANSLATE
[pspp] / doc / statistics.texi
1 @node Statistics
2 @chapter Statistics
3
4 This chapter documents the statistical procedures that @pspp{} supports so
5 far.
6
7 @menu
8 * DESCRIPTIVES::                Descriptive statistics.
9 * FREQUENCIES::                 Frequency tables.
10 * EXAMINE::                     Testing data for normality.
11 * CORRELATIONS::                Correlation tables.
12 * CROSSTABS::                   Crosstabulation tables.
13 * FACTOR::                      Factor analysis and Principal Components analysis.
14 * LOGISTIC REGRESSION::         Bivariate Logistic Regression.
15 * MEANS::                       Average values and other statistics.
16 * NPAR TESTS::                  Nonparametric tests.
17 * T-TEST::                      Test hypotheses about means.
18 * ONEWAY::                      One way analysis of variance.
19 * QUICK CLUSTER::               K-Means clustering.
20 * RANK::                        Compute rank scores.
21 * REGRESSION::                  Linear regression.
22 * RELIABILITY::                 Reliability analysis.
23 * ROC::                         Receiver Operating Characteristic.
24 @end menu
25
26 @node DESCRIPTIVES
27 @section DESCRIPTIVES
28
29 @vindex DESCRIPTIVES
30 @display
31 DESCRIPTIVES
32         /VARIABLES=@var{var_list}
33         /MISSING=@{VARIABLE,LISTWISE@} @{INCLUDE,NOINCLUDE@}
34         /FORMAT=@{LABELS,NOLABELS@} @{NOINDEX,INDEX@} @{LINE,SERIAL@}
35         /SAVE
36         /STATISTICS=@{ALL,MEAN,SEMEAN,STDDEV,VARIANCE,KURTOSIS,
37                      SKEWNESS,RANGE,MINIMUM,MAXIMUM,SUM,DEFAULT,
38                      SESKEWNESS,SEKURTOSIS@}
39         /SORT=@{NONE,MEAN,SEMEAN,STDDEV,VARIANCE,KURTOSIS,SKEWNESS,
40                RANGE,MINIMUM,MAXIMUM,SUM,SESKEWNESS,SEKURTOSIS,NAME@}
41               @{A,D@}
42 @end display
43
44 The @cmd{DESCRIPTIVES} procedure reads the active dataset and outputs
45 descriptive
46 statistics requested by the user.  In addition, it can optionally
47 compute Z-scores.
48
49 The @subcmd{VARIABLES} subcommand, which is required, specifies the list of
50 variables to be analyzed.  Keyword @subcmd{VARIABLES} is optional.
51
52 All other subcommands are optional:
53
54 The @subcmd{MISSING} subcommand determines the handling of missing variables.  If
55 @subcmd{INCLUDE} is set, then user-missing values are included in the
56 calculations.  If @subcmd{NOINCLUDE} is set, which is the default, user-missing
57 values are excluded.  If @subcmd{VARIABLE} is set, then missing values are
58 excluded on a variable by variable basis; if @subcmd{LISTWISE} is set, then
59 the entire case is excluded whenever any value in that case has a
60 system-missing or, if @subcmd{INCLUDE} is set, user-missing value.
61
62 The @subcmd{FORMAT} subcommand affects the output format.  Currently the
63 @subcmd{LABELS/NOLABELS} and @subcmd{NOINDEX/INDEX} settings are not used.
64 When @subcmd{SERIAL} is
65 set, both valid and missing number of cases are listed in the output;
66 when @subcmd{NOSERIAL} is set, only valid cases are listed.
67
68 The @subcmd{SAVE} subcommand causes @cmd{DESCRIPTIVES} to calculate Z scores for all
69 the specified variables.  The Z scores are saved to new variables.
70 Variable names are generated by trying first the original variable name
71 with Z prepended and truncated to a maximum of 8 characters, then the
72 names ZSC000 through ZSC999, STDZ00 through STDZ09, ZZZZ00 through
73 ZZZZ09, ZQZQ00 through ZQZQ09, in that sequence.  In addition, Z score
74 variable names can be specified explicitly on @subcmd{VARIABLES} in the variable
75 list by enclosing them in parentheses after each variable.
76 When Z scores are calculated, @pspp{} ignores @cmd{TEMPORARY},
77 treating temporary transformations as permanent.
78
79 The @subcmd{STATISTICS} subcommand specifies the statistics to be displayed:
80
81 @table @code
82 @item @subcmd{ALL}
83 All of the statistics below.
84 @item @subcmd{MEAN}
85 Arithmetic mean.
86 @item @subcmd{SEMEAN}
87 Standard error of the mean.
88 @item @subcmd{STDDEV}
89 Standard deviation.
90 @item @subcmd{VARIANCE}
91 Variance.
92 @item @subcmd{KURTOSIS}
93 Kurtosis and standard error of the kurtosis.
94 @item @subcmd{SKEWNESS}
95 Skewness and standard error of the skewness.
96 @item @subcmd{RANGE}
97 Range.
98 @item MINIMUM
99 Minimum value.
100 @item MAXIMUM
101 Maximum value.
102 @item SUM
103 Sum.
104 @item DEFAULT
105 Mean, standard deviation of the mean, minimum, maximum.
106 @item SEKURTOSIS
107 Standard error of the kurtosis.
108 @item SESKEWNESS
109 Standard error of the skewness.
110 @end table
111
112 The @subcmd{SORT} subcommand specifies how the statistics should be sorted.  Most
113 of the possible values should be self-explanatory.  @subcmd{NAME} causes the
114 statistics to be sorted by name.  By default, the statistics are listed
115 in the order that they are specified on the @subcmd{VARIABLES} subcommand.
116 The @subcmd{A} and @subcmd{D} settings request an ascending or descending
117 sort order, respectively.
118
119 @node FREQUENCIES
120 @section FREQUENCIES
121
122 @vindex FREQUENCIES
123 @display
124 FREQUENCIES
125         /VARIABLES=@var{var_list}
126         /FORMAT=@{TABLE,NOTABLE,LIMIT(@var{limit})@}
127                 @{AVALUE,DVALUE,AFREQ,DFREQ@}
128         /MISSING=@{EXCLUDE,INCLUDE@}
129         /STATISTICS=@{DEFAULT,MEAN,SEMEAN,MEDIAN,MODE,STDDEV,VARIANCE,
130                      KURTOSIS,SKEWNESS,RANGE,MINIMUM,MAXIMUM,SUM,
131                      SESKEWNESS,SEKURTOSIS,ALL,NONE@}
132         /NTILES=@var{ntiles}
133         /PERCENTILES=percent@dots{}
134         /HISTOGRAM=[MINIMUM(@var{x_min})] [MAXIMUM(@var{x_max})] 
135                    [@{FREQ[(@var{y_max})],PERCENT[(@var{y_max})]@}] [@{NONORMAL,NORMAL@}]
136         /PIECHART=[MINIMUM(@var{x_min})] [MAXIMUM(@var{x_max})]
137                   [@{FREQ,PERCENT@}] [@{NOMISSING,MISSING@}]
138
139 (These options are not currently implemented.)
140         /BARCHART=@dots{}
141         /HBAR=@dots{}
142         /GROUPED=@dots{}
143 @end display
144
145 The @cmd{FREQUENCIES} procedure outputs frequency tables for specified
146 variables.
147 @cmd{FREQUENCIES} can also calculate and display descriptive statistics
148 (including median and mode) and percentiles,
149 @cmd{FREQUENCIES} can also output
150 histograms and pie charts.  
151
152 The @subcmd{VARIABLES} subcommand is the only required subcommand.  Specify the
153 variables to be analyzed.
154
155 The @subcmd{FORMAT} subcommand controls the output format.  It has several
156 possible settings:  
157
158 @itemize @subcmd{}
159 @item
160 @subcmd{TABLE}, the default, causes a frequency table to be output for every
161 variable specified.  @subcmd{NOTABLE} prevents them from being output.  @subcmd{LIMIT}
162 with a numeric argument causes them to be output except when there are
163 more than the specified number of values in the table.
164
165 @item
166 Normally frequency tables are sorted in ascending order by value.  This
167 is @subcmd{AVALUE}.  @subcmd{DVALUE} tables are sorted in descending order by value.
168 @subcmd{AFREQ} and @subcmd{DFREQ} tables are sorted in ascending and descending order,
169 respectively, by frequency count.
170 @end itemize
171
172 The @subcmd{MISSING} subcommand controls the handling of user-missing values.
173 When @subcmd{EXCLUDE}, the default, is set, user-missing values are not included
174 in frequency tables or statistics.  When @subcmd{INCLUDE} is set, user-missing
175 are included.  System-missing values are never included in statistics,
176 but are listed in frequency tables.
177
178 The available @subcmd{STATISTICS} are the same as available 
179 in @cmd{DESCRIPTIVES} (@pxref{DESCRIPTIVES}), with the addition 
180 of @subcmd{MEDIAN}, the data's median
181 value, and MODE, the mode.  (If there are multiple modes, the smallest
182 value is reported.)  By default, the mean, standard deviation of the
183 mean, minimum, and maximum are reported for each variable.
184
185 @cindex percentiles
186 @subcmd{PERCENTILES} causes the specified percentiles to be reported.
187 The percentiles should  be presented at a list of numbers between 0
188 and 100 inclusive.  
189 The @subcmd{NTILES} subcommand causes the percentiles to be reported at the
190 boundaries of the data set divided into the specified number of ranges.
191 For instance, @subcmd{/NTILES=4} would cause quartiles to be reported.
192
193 @cindex histogram
194 The @subcmd{HISTOGRAM} subcommand causes the output to include a histogram for
195 each specified numeric variable.  The X axis by default ranges from
196 the minimum to the maximum value observed in the data, but the @subcmd{MINIMUM}
197 and @subcmd{MAXIMUM} keywords can set an explicit range.  Specify @subcmd{NORMAL} to
198 superimpose a normal curve on the histogram.  Histograms are not
199 created for string variables.
200
201 @cindex piechart
202 The @subcmd{PIECHART} subcommand adds a pie chart for each variable to the data.  Each
203 slice represents one value, with the size of the slice proportional to
204 the value's frequency.  By default, all non-missing values are given
205 slices.  The @subcmd{MINIMUM} and @subcmd{MAXIMUM} keywords can be used to limit the
206 displayed slices to a given range of values.  The @subcmd{MISSING} keyword adds
207 slices for missing values.
208
209 The @subcmd{FREQ} and @subcmd{PERCENT} options on @subcmd{HISTOGRAM} and @subcmd{PIECHART} are accepted
210 but not currently honoured.
211
212 @node EXAMINE
213 @section EXAMINE
214
215 @vindex EXAMINE
216 @cindex Exploratory data analysis
217 @cindex Normality, testing for
218
219 @display
220 EXAMINE
221         VARIABLES= @var{var1} [@var{var2}] @dots{} [@var{varN}]
222            [BY @var{factor1} [BY @var{subfactor1}]
223              [ @var{factor2} [BY @var{subfactor2}]]
224              @dots{}
225              [ @var{factor3} [BY @var{subfactor3}]]
226             ]
227         /STATISTICS=@{DESCRIPTIVES, EXTREME[(@var{n})], ALL, NONE@}
228         /PLOT=@{BOXPLOT, NPPLOT, HISTOGRAM, SPREADLEVEL[(@var{t})], ALL, NONE@}
229         /CINTERVAL @var{p}
230         /COMPARE=@{GROUPS,VARIABLES@}
231         /ID=@var{identity_variable}
232         /@{TOTAL,NOTOTAL@}
233         /PERCENTILE=[@var{percentiles}]=@{HAVERAGE, WAVERAGE, ROUND, AEMPIRICAL, EMPIRICAL @}
234         /MISSING=@{LISTWISE, PAIRWISE@} [@{EXCLUDE, INCLUDE@}] 
235                 [@{NOREPORT,REPORT@}]
236
237 @end display
238
239 The @cmd{EXAMINE} command is used to perform exploratory data analysis.
240 In particular, it is useful for testing how closely a distribution follows a
241 normal distribution, and for finding outliers and extreme values.
242
243 The @subcmd{VARIABLES} subcommand is mandatory.  
244 It specifies the dependent variables and optionally variables to use as
245 factors for the analysis.
246 Variables listed before the first @subcmd{BY} keyword (if any) are the 
247 dependent variables.
248 The dependent variables may optionally be followed by a list of
249 factors which tell @pspp{} how to break down the analysis for each
250 dependent variable. 
251
252 Following the dependent variables, factors may be specified.
253 The factors (if desired) should be preceeded by a single @subcmd{BY} keyword.
254 The format for each factor is 
255 @display
256 @var{factorvar} [BY @var{subfactorvar}].
257 @end display
258 Each unique combination of the values of  @var{factorvar} and
259 @var{subfactorvar} divide the dataset into @dfn{cells}.
260 Statistics will be calculated for each cell
261 and for the entire dataset (unless @subcmd{NOTOTAL} is given).
262
263 The @subcmd{STATISTICS} subcommand specifies which statistics to show.
264 @subcmd{DESCRIPTIVES} will produce a table showing some parametric and
265 non-parametrics statistics.
266 @subcmd{EXTREME} produces a table showing the extremities of each cell.
267 A number in parentheses, @var{n} determines
268 how many upper and lower extremities to show.
269 The default number is 5.
270
271 The subcommands @subcmd{TOTAL} and @subcmd{NOTOTAL} are mutually exclusive.
272 If @subcmd{TOTAL} appears, then statistics will be produced for the entire dataset
273 as well as for each cell.
274 If @subcmd{NOTOTAL} appears, then statistics will be produced only for the cells
275 (unless no factor variables have been given).
276 These subcommands have no effect if there have  been no factor variables
277 specified.
278
279 @cindex boxplot
280 @cindex histogram
281 @cindex npplot
282 @cindex spreadlevel plot
283 The @subcmd{PLOT} subcommand specifies which plots are to be produced if any.
284 Available plots are @subcmd{HISTOGRAM}, @subcmd{NPPLOT},  @subcmd{BOXPLOT} and
285 @subcmd{SPREADLEVEL}.
286 The first three can be used to visualise how closely each cell conforms to a 
287 normal distribution, whilst the spread vs.@: level plot can be useful to visualise
288 how the variance of differs between factors.
289 Boxplots will also show you the outliers and extreme values.
290
291 The @subcmd{SPREADLEVEL} plot displays the interquartile range versus the 
292 median.  It takes an optional parameter @var{t}, which specifies how the data
293 should be transformed prior to plotting.
294 The given value @var{t} is a power to which the data is raised.  For example, if
295 @var{t} is given as 2, then the data will be squared.
296 Zero, however is a special value.  If @var{t} is 0 or 
297 is omitted, then data will be transformed by taking its natural logarithm instead of
298 raising to the power of @var{t}.
299
300 The @subcmd{COMPARE} subcommand is only relevant if producing boxplots, and it is only 
301 useful there is more than one dependent variable and at least one factor.
302 If 
303 @subcmd{/COMPARE=GROUPS} is specified, then one plot per dependent variable is produced,
304 each of which contain boxplots for all the cells.
305 If @subcmd{/COMPARE=VARIABLES} is specified, then one plot per cell is produced,
306 each containing one boxplot per dependent variable.
307 If the @subcmd{/COMPARE} subcommand is omitted, then @pspp{} behaves as if
308 @subcmd{/COMPARE=GROUPS} were given.
309  
310 The @subcmd{ID} subcommand is relevant only if @subcmd{/PLOT=BOXPLOT} or 
311 @subcmd{/STATISTICS=EXTREME} has been given.
312 If given, it shoule provide the name of a variable which is to be used
313 to labels extreme values and outliers.
314 Numeric or string variables are permissible.  
315 If the @subcmd{ID} subcommand is not given, then the casenumber will be used for
316 labelling.
317
318 The @subcmd{CINTERVAL} subcommand specifies the confidence interval to use in
319 calculation of the descriptives command.  The default is 95%.
320
321 @cindex percentiles
322 The @subcmd{PERCENTILES} subcommand specifies which percentiles are to be calculated, 
323 and which algorithm to use for calculating them.  The default is to
324 calculate the 5, 10, 25, 50, 75, 90, 95 percentiles using the
325 @subcmd{HAVERAGE} algorithm.
326
327 The @subcmd{TOTAL} and @subcmd{NOTOTAL} subcommands are mutually exclusive.  If @subcmd{NOTOTAL}
328 is given and factors have been specified in the @subcmd{VARIABLES} subcommand,
329 then then statistics for the unfactored dependent variables are
330 produced in addition to the factored variables.  If there are no
331 factors specified then @subcmd{TOTAL} and @subcmd{NOTOTAL} have no effect.
332
333
334 The following example will generate descriptive statistics and histograms for
335 two variables @var{score1} and @var{score2}.
336 Two factors are given, @i{viz}: @var{gender} and @var{gender} BY @var{culture}.
337 Therefore, the descriptives and histograms will be generated for each
338 distinct  value
339 of @var{gender} @emph{and} for each distinct combination of the values
340 of @var{gender} and @var{race}.
341 Since the @subcmd{NOTOTAL} keyword is given, statistics and histograms for 
342 @var{score1} and @var{score2} covering the  whole dataset are not produced.
343 @example
344 EXAMINE @var{score1} @var{score2} BY 
345         @var{gender}
346         @var{gender} BY @var{culture}
347         /STATISTICS = DESCRIPTIVES
348         /PLOT = HISTOGRAM
349         /NOTOTAL.
350 @end example
351
352 Here is a second example showing how the @cmd{examine} command can be used to find extremities.
353 @example
354 EXAMINE @var{height} @var{weight} BY 
355         @var{gender}
356         /STATISTICS = EXTREME (3)
357         /PLOT = BOXPLOT
358         /COMPARE = GROUPS
359         /ID = @var{name}.
360 @end example
361 In this example, we look at the height and weight of a sample of individuals and
362 how they differ between male and female.
363 A table showing the 3 largest and the 3 smallest values of @var{height} and 
364 @var{weight} for each gender, and for the whole dataset will be shown.
365 Boxplots will also be produced.
366 Because @subcmd{/COMPARE = GROUPS} was given, boxplots for male and female will be
367 shown in the same graphic, allowing us to easily see the difference between
368 the genders.
369 Since the variable @var{name} was specified on the @subcmd{ID} subcommand, this will be
370 used to label the extreme values.
371
372 @strong{Warning!}
373 If many dependent variables are specified, or if factor variables are
374 specified for which
375 there are many distinct values, then @cmd{EXAMINE} will produce a very
376 large quantity of output.
377
378 @node CORRELATIONS
379 @section CORRELATIONS
380
381 @vindex CORRELATIONS
382 @display
383 CORRELATIONS
384      /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
385      [
386       .
387       .
388       .
389       /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
390       /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
391      ]
392
393      [ /PRINT=@{TWOTAIL, ONETAIL@} @{SIG, NOSIG@} ]
394      [ /STATISTICS=DESCRIPTIVES XPROD ALL]
395      [ /MISSING=@{PAIRWISE, LISTWISE@} @{INCLUDE, EXCLUDE@} ]
396 @end display    
397
398 @cindex correlation
399 The @cmd{CORRELATIONS} procedure produces tables of the Pearson correlation coefficient
400 for a set of variables.  The significance of the coefficients are also given.
401
402 At least one @subcmd{VARIABLES} subcommand is required. If the @subcmd{WITH} 
403 keyword is used, then a non-square correlation table will be produced.
404 The variables preceding @subcmd{WITH}, will be used as the rows of the table,
405 and the variables following will be the columns of the table.
406 If no @subcmd{WITH} subcommand is given, then a square, symmetrical table using all variables is produced.
407
408
409 The @cmd{MISSING} subcommand determines the handling of missing variables.  
410 If @subcmd{INCLUDE} is set, then user-missing values are included in the
411 calculations, but system-missing values are not.
412 If @subcmd{EXCLUDE} is set, which is the default, user-missing
413 values are excluded as well as system-missing values. 
414
415 If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
416 whenever any variable  specified in any @cmd{/VARIABLES} subcommand
417 contains a missing value.   
418 If @subcmd{PAIRWISE} is set, then a case is considered missing only if either of the
419 values  for the particular coefficient are missing.
420 The default is @subcmd{PAIRWISE}.
421
422 The @subcmd{PRINT} subcommand is used to control how the reported significance values are printed.
423 If the @subcmd{TWOTAIL} option is used, then a two-tailed test of significance is 
424 printed.  If the @subcmd{ONETAIL} option is given, then a one-tailed test is used.
425 The default is @subcmd{TWOTAIL}.
426
427 If the @subcmd{NOSIG} option is specified, then correlation coefficients with significance less than
428 0.05 are highlighted.
429 If @subcmd{SIG} is specified, then no highlighting is performed.  This is the default.
430
431 @cindex covariance
432 The @subcmd{STATISTICS} subcommand requests additional statistics to be displayed.  The keyword 
433 @subcmd{DESCRIPTIVES} requests that the mean, number of non-missing cases, and the non-biased
434 estimator of the standard deviation are displayed.
435 These statistics will be displayed in a separated table, for all the variables listed
436 in any @subcmd{/VARIABLES} subcommand.
437 The @subcmd{XPROD} keyword requests cross-product deviations and covariance estimators to 
438 be displayed for each pair of variables.
439 The keyword @subcmd{ALL} is the union of @subcmd{DESCRIPTIVES} and @subcmd{XPROD}.
440
441 @node CROSSTABS
442 @section CROSSTABS
443
444 @vindex CROSSTABS
445 @display
446 CROSSTABS
447         /TABLES=@var{var_list} BY @var{var_list} [BY @var{var_list}]@dots{}
448         /MISSING=@{TABLE,INCLUDE,REPORT@}
449         /WRITE=@{NONE,CELLS,ALL@}
450         /FORMAT=@{TABLES,NOTABLES@}
451                 @{PIVOT,NOPIVOT@}
452                 @{AVALUE,DVALUE@}
453                 @{NOINDEX,INDEX@}
454                 @{BOX,NOBOX@}
455         /CELLS=@{COUNT,ROW,COLUMN,TOTAL,EXPECTED,RESIDUAL,SRESIDUAL,
456                 ASRESIDUAL,ALL,NONE@}
457         /STATISTICS=@{CHISQ,PHI,CC,LAMBDA,UC,BTAU,CTAU,RISK,GAMMA,D,
458                      KAPPA,ETA,CORR,ALL,NONE@}
459         
460 (Integer mode.)
461         /VARIABLES=@var{var_list} (@var{low},@var{high})@dots{}
462 @end display
463
464 The @cmd{CROSSTABS} procedure displays crosstabulation
465 tables requested by the user.  It can calculate several statistics for
466 each cell in the crosstabulation tables.  In addition, a number of
467 statistics can be calculated for each table itself.
468
469 The @subcmd{TABLES} subcommand is used to specify the tables to be reported.  Any
470 number of dimensions is permitted, and any number of variables per
471 dimension is allowed.  The @subcmd{TABLES} subcommand may be repeated as many
472 times as needed.  This is the only required subcommand in @dfn{general
473 mode}.  
474
475 Occasionally, one may want to invoke a special mode called @dfn{integer
476 mode}.  Normally, in general mode, @pspp{} automatically determines
477 what values occur in the data.  In integer mode, the user specifies the
478 range of values that the data assumes.  To invoke this mode, specify the
479 @subcmd{VARIABLES} subcommand, giving a range of data values in parentheses for
480 each variable to be used on the @subcmd{TABLES} subcommand.  Data values inside
481 the range are truncated to the nearest integer, then assigned to that
482 value.  If values occur outside this range, they are discarded.  When it
483 is present, the @subcmd{VARIABLES} subcommand must precede the @subcmd{TABLES}
484 subcommand.
485
486 In general mode, numeric and string variables may be specified on
487 TABLES.  In integer mode, only numeric variables are allowed.
488
489 The @subcmd{MISSING} subcommand determines the handling of user-missing values.
490 When set to @subcmd{TABLE}, the default, missing values are dropped on a table by
491 table basis.  When set to @subcmd{INCLUDE}, user-missing values are included in
492 tables and statistics.  When set to @subcmd{REPORT}, which is allowed only in
493 integer mode, user-missing values are included in tables but marked with
494 an @samp{M} (for ``missing'') and excluded from statistical
495 calculations.
496
497 Currently the @subcmd{WRITE} subcommand is ignored.
498
499 The @subcmd{FORMAT} subcommand controls the characteristics of the
500 crosstabulation tables to be displayed.  It has a number of possible
501 settings:
502
503 @itemize @asis
504 @item
505 @subcmd{TABLES}, the default, causes crosstabulation tables to be output.
506 @subcmd{NOTABLES} suppresses them.
507
508 @item
509 @subcmd{PIVOT}, the default, causes each @subcmd{TABLES} subcommand to be displayed in a
510 pivot table format.  @subcmd{NOPIVOT} causes the old-style crosstabulation format
511 to be used.
512
513 @item
514 @subcmd{AVALUE}, the default, causes values to be sorted in ascending order.
515 @subcmd{DVALUE} asserts a descending sort order.
516
517 @item
518 @subcmd{INDEX} and @subcmd{NOINDEX} are currently ignored.
519
520 @item
521 @subcmd{BOX} and @subcmd{NOBOX} is currently ignored.
522 @end itemize
523
524 The @subcmd{CELLS} subcommand controls the contents of each cell in the displayed
525 crosstabulation table.  The possible settings are:
526
527 @table @asis
528 @item COUNT
529 Frequency count.
530 @item ROW
531 Row percent.
532 @item COLUMN
533 Column percent.
534 @item TOTAL
535 Table percent.
536 @item EXPECTED
537 Expected value.
538 @item RESIDUAL 
539 Residual.
540 @item SRESIDUAL
541 Standardized residual.
542 @item ASRESIDUAL
543 Adjusted standardized residual.
544 @item ALL
545 All of the above.
546 @item NONE
547 Suppress cells entirely.
548 @end table
549
550 @samp{/CELLS} without any settings specified requests @subcmd{COUNT}, @subcmd{ROW},
551 @subcmd{COLUMN}, and @subcmd{TOTAL}.  
552 If @subcmd{CELLS} is not specified at all then only @subcmd{COUNT}
553 will be selected.
554
555 The @subcmd{STATISTICS} subcommand selects statistics for computation:
556
557 @table @asis
558 @item CHISQ
559 @cindex chisquare
560 @cindex chi-square
561
562 Pearson chi-square, likelihood ratio, Fisher's exact test, continuity
563 correction, linear-by-linear association.
564 @item PHI
565 Phi.
566 @item CC
567 Contingency coefficient.
568 @item LAMBDA
569 Lambda.
570 @item UC
571 Uncertainty coefficient.
572 @item BTAU
573 Tau-b.
574 @item CTAU
575 Tau-c.
576 @item RISK
577 Risk estimate.
578 @item GAMMA
579 Gamma.
580 @item D
581 Somers' D.
582 @item KAPPA
583 Cohen's Kappa.
584 @item ETA
585 Eta.
586 @item CORR
587 Spearman correlation, Pearson's r.
588 @item ALL
589 All of the above.
590 @item NONE
591 No statistics.
592 @end table
593
594 Selected statistics are only calculated when appropriate for the
595 statistic.  Certain statistics require tables of a particular size, and
596 some statistics are calculated only in integer mode.
597
598 @samp{/STATISTICS} without any settings selects CHISQ.  If the
599 @subcmd{STATISTICS} subcommand is not given, no statistics are calculated.
600
601 @strong{Please note:} Currently the implementation of @cmd{CROSSTABS} has the
602 followings bugs:
603
604 @itemize @bullet
605 @item
606 Pearson's R (but not Spearman) is off a little.
607 @item
608 T values for Spearman's R and Pearson's R are wrong.
609 @item
610 Significance of symmetric and directional measures is not calculated.
611 @item
612 Asymmetric ASEs and T values for lambda are wrong.
613 @item
614 ASE of Goodman and Kruskal's tau is not calculated.
615 @item
616 ASE of symmetric somers' d is wrong.
617 @item
618 Approximate T of uncertainty coefficient is wrong.
619 @end itemize
620
621 Fixes for any of these deficiencies would be welcomed.
622
623 @node FACTOR
624 @section FACTOR
625
626 @vindex FACTOR
627 @cindex factor analysis
628 @cindex principal components analysis
629 @cindex principal axis factoring
630 @cindex data reduction
631
632 @display
633 FACTOR  VARIABLES=@var{var_list}
634
635         [ /METHOD = @{CORRELATION, COVARIANCE@} ]
636
637         [ /EXTRACTION=@{PC, PAF@}] 
638
639         [ /ROTATION=@{VARIMAX, EQUAMAX, QUARTIMAX, NOROTATE@}]
640
641         [ /PRINT=[INITIAL] [EXTRACTION] [ROTATION] [UNIVARIATE] [CORRELATION] [COVARIANCE] [DET] [KMO] [SIG] [ALL] [DEFAULT] ]
642
643         [ /PLOT=[EIGEN] ]
644
645         [ /FORMAT=[SORT] [BLANK(@var{n})] [DEFAULT] ]
646
647         [ /CRITERIA=[FACTORS(@var{n})] [MINEIGEN(@var{l})] [ITERATE(@var{m})] [ECONVERGE (@var{delta})] [DEFAULT] ]
648
649         [ /MISSING=[@{LISTWISE, PAIRWISE@}] [@{INCLUDE, EXCLUDE@}] ]
650 @end display
651
652 The @cmd{FACTOR} command performs Factor Analysis or Principal Axis Factoring on a dataset.  It may be used to find
653 common factors in the data or for data reduction purposes.
654
655 The @subcmd{VARIABLES} subcommand is required.  It lists the variables which are to partake in the analysis.
656
657 The @subcmd{/EXTRACTION} subcommand is used to specify the way in which factors (components) are extracted from the data.
658 If @subcmd{PC} is specified, then Principal Components Analysis is used.  
659 If @subcmd{PAF} is specified, then Principal Axis Factoring is
660 used. By default Principal Components Analysis will be used.
661
662 The @subcmd{/ROTATION} subcommand is used to specify the method by which the extracted solution will be rotated.
663 Three methods are available: @subcmd{VARIMAX} (which is the default), @subcmd{EQUAMAX}, and @subcmd{QUARTIMAX}.
664 If don't want any rotation to be performed, the word @subcmd{NOROTATE} will prevent the command from performing any
665 rotation on the data. Oblique rotations are not supported.
666
667 The @subcmd{/METHOD} subcommand should be used to determine whether the covariance matrix or the correlation matrix of the data is
668 to be analysed.  By default, the correlation matrix is analysed.
669
670 The @subcmd{/PRINT} subcommand may be used to select which features of the analysis are reported:
671
672 @itemize 
673 @item @subcmd{UNIVARIATE}
674       A table of mean values, standard deviations and total weights are printed.
675 @item @subcmd{INITIAL}
676       Initial communalities and eigenvalues are printed.
677 @item @subcmd{EXTRACTION}
678       Extracted communalities and eigenvalues are printed.
679 @item @subcmd{ROTATION}
680       Rotated communalities and eigenvalues are printed.
681 @item @subcmd{CORRELATION}
682       The correlation matrix is printed.
683 @item @subcmd{COVARIANCE}
684       The covariance matrix is printed.
685 @item @subcmd{DET}
686       The determinant of the correlation or covariance matrix is printed.
687 @item @subcmd{KMO}
688       The Kaiser-Meyer-Olkin measure of sampling adequacy and the Bartlett test of sphericity is printed.
689 @item @subcmd{SIG}
690       The significance of the elements of correlation matrix is printed.
691 @item @subcmd{ALL}
692       All of the above are printed.
693 @item @subcmd{DEFAULT}
694       Identical to @subcmd{INITIAL} and @subcmd{EXTRACTION}.
695 @end itemize
696
697 If @subcmd{/PLOT=EIGEN} is given, then a ``Scree'' plot of the eigenvalues will be printed.  This can be useful for visualizing
698 which factors (components) should be retained.
699
700 The @subcmd{/FORMAT} subcommand determined how data are to be displayed in loading matrices.  If @subcmd{SORT} is specified, then the variables
701 are sorted in descending order of significance.  If @subcmd{BLANK(@var{n})} is specified, then coefficients whose absolute value is less
702 than @var{n} will not be printed.  If the keyword @subcmd{DEFAULT} is given, or if no @subcmd{/FORMAT} subcommand is given, then no sorting is 
703 performed, and all coefficients will be printed.
704
705 The @subcmd{/CRITERIA} subcommand is used to specify how the number of extracted factors (components) are chosen.
706 If @subcmd{FACTORS(@var{n})} is
707 specified, where @var{n} is an integer, then @var{n} factors will be extracted.  Otherwise, the @subcmd{MINEIGEN} setting will
708 be used.  @subcmd{MINEIGEN(@var{l})} requests that all factors whose eigenvalues are greater than or equal to @var{l} are extracted.
709 The default value of @var{l} is 1.    The @subcmd{ECONVERGE} and @subcmd{ITERATE} settings have effect only when iterative algorithms for factor
710 extraction (such as Principal Axis Factoring) are used.   @subcmd{ECONVERGE(@var{delta})} specifies that
711 iteration should cease when
712 the maximum absolute value of the communality estimate between one iteration and the previous is less than @var{delta}. The
713 default value of @var{delta} is 0.001.
714 The @subcmd{ITERATE(@var{m})} setting sets the maximum number of iterations to @var{m}.  The default value of @var{m} is 25.
715
716 The @cmd{MISSING} subcommand determines the handling of missing variables.  
717 If @subcmd{INCLUDE} is set, then user-missing values are included in the
718 calculations, but system-missing values are not.
719 If @subcmd{EXCLUDE} is set, which is the default, user-missing
720 values are excluded as well as system-missing values. 
721 This is the default.
722 If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
723 whenever any variable  specified in the @cmd{VARIABLES} subcommand
724 contains a missing value.   
725 If @subcmd{PAIRWISE} is set, then a case is considered missing only if either of the
726 values  for the particular coefficient are missing.
727 The default is @subcmd{LISTWISE}.
728
729 @node LOGISTIC REGRESSION
730 @section LOGISTIC REGRESSION
731
732 @vindex LOGISTIC REGRESSION
733 @cindex logistic regression
734 @cindex bivariate logistic regression
735
736 @display
737 LOGISTIC REGRESSION [VARIABLES =] @var{dependent_var} WITH @var{predictors}
738
739      [/CATEGORICAL = @var{categorical_predictors}]
740
741      [@{/NOCONST | /ORIGIN | /NOORIGIN @}]
742
743      [/PRINT = [SUMMARY] [DEFAULT] [CI(@var{confidence})] [ALL]]
744
745      [/CRITERIA = [BCON(@var{min_delta})] [ITERATE(@var{max_interations})]
746                   [LCON(@var{min_likelihood_delta})] [EPS(@var{min_epsilon})]
747                   [CUT(@var{cut_point})]]
748
749      [/MISSING = @{INCLUDE|EXCLUDE@}]
750 @end display
751
752 Bivariate Logistic Regression is used when you want to explain a dichotomous dependent
753 variable in terms of one or more predictor variables.
754
755 The minimum command is
756 @example
757 LOGISTIC REGRESSION @var{y} WITH @var{x1} @var{x2} @dots{} @var{xn}.
758 @end example
759 Here, @var{y} is the dependent variable, which must be dichotomous and @var{x1} @dots{} @var{xn}
760 are the predictor variables whose coefficients the procedure estimates.
761
762 By default, a constant term is included in the model.
763 Hence, the full model is
764 @math{
765 {\bf y} 
766 = b_0 + b_1 {\bf x_1} 
767 + b_2 {\bf x_2} 
768 + \dots
769 + b_n {\bf x_n}
770 }
771
772 Predictor variables which are categorical in nature should be listed on the @subcmd{/CATEGORICAL} subcommand.
773 Simple variables as well as interactions between variables may be listed here.
774
775 If you want a model without the constant term @math{b_0}, use the keyword @subcmd{/ORIGIN}.
776 @subcmd{/NOCONST} is a synonym for @subcmd{/ORIGIN}.
777
778 An iterative Newton-Raphson procedure is used to fit the model.
779 The @subcmd{/CRITERIA} subcommand is used to specify the stopping criteria of the procedure,
780 and other parameters.
781 The value of @var{cut_point} is used in the classification table.  It is the 
782 threshold above which predicted values are considered to be 1.  Values
783 of @var{cut_point} must lie in the range [0,1].
784 During iterations, if any one of the stopping criteria are satisfied, the procedure is
785 considered complete.
786 The stopping criteria are:
787 @itemize
788 @item The number of iterations exceeds @var{max_iterations}.  
789       The default value of @var{max_iterations} is 20.
790 @item The change in the all coefficient estimates are less than @var{min_delta}.
791 The default value of @var{min_delta} is 0.001.
792 @item The magnitude of change in the likelihood estimate is less than @var{min_likelihood_delta}.
793 The default value of @var{min_delta} is zero.
794 This means that this criterion is disabled.
795 @item The differential of the estimated probability for all cases is less than @var{min_epsilon}.
796 In other words, the probabilities are close to zero or one.
797 The default value of @var{min_epsilon} is 0.00000001.
798 @end itemize
799
800
801 The @subcmd{PRINT} subcommand controls the display of optional statistics.
802 Currently there is one such option, @subcmd{CI}, which indicates that the 
803 confidence interval of the odds ratio should be displayed as well as its value.
804 @subcmd{CI} should be followed by an integer in parentheses, to indicate the
805 confidence level of the desired confidence interval.
806
807 The @subcmd{MISSING} subcommand determines the handling of missing
808 variables.  
809 If @subcmd{INCLUDE} is set, then user-missing values are included in the
810 calculations, but system-missing values are not.
811 If @subcmd{EXCLUDE} is set, which is the default, user-missing
812 values are excluded as well as system-missing values. 
813 This is the default.
814
815 @node MEANS
816 @section MEANS
817
818 @vindex MEANS
819 @cindex means
820
821 @display 
822 MEANS [TABLES =] 
823       @{@var{var_list}@} 
824         [ BY @{@var{var_list}@} [BY @{@var{var_list}@} [BY @{@var{var_list}@} @dots{} ]]]
825
826       [ /@{@var{var_list}@} 
827          [ BY @{@var{var_list}@} [BY @{@var{var_list}@} [BY @{@var{var_list}@} @dots{} ]]] ]
828
829       [/CELLS = [MEAN] [COUNT] [STDDEV] [SEMEAN] [SUM] [MIN] [MAX] [RANGE]
830         [VARIANCE] [KURT] [SEKURT] 
831         [SKEW] [SESKEW] [FIRST] [LAST] 
832         [HARMONIC] [GEOMETRIC] 
833         [DEFAULT]
834         [ALL]
835         [NONE] ]
836
837       [/MISSING = [TABLE] [INCLUDE] [DEPENDENT]]
838 @end display 
839
840 You can use the @cmd{MEANS} command to calculate the arithmetic mean and similar
841 statistics, either for the dataset as a whole or for categories of data.
842
843 The simplest form of the command is
844 @example
845 MEANS @var{v}.
846 @end example
847 @noindent which calculates the mean, count and standard deviation for @var{v}.
848 If you specify a grouping variable, for example
849 @example
850 MEANS @var{v} BY @var{g}.
851 @end example
852 @noindent then the means, counts and standard deviations for @var{v} after having
853 been grouped by @var{g} will be calculated.
854 Instead of the mean, count and standard deviation, you could specify the statistics
855 in which you are interested:
856 @example
857 MEANS @var{x} @var{y} BY @var{g}
858       /CELLS = HARMONIC SUM MIN.
859 @end example
860 This example calculates the harmonic mean, the sum and the minimum values of @var{x} and @var{y}
861 grouped by @var{g}.
862
863 The @subcmd{CELLS} subcommand specifies which statistics to calculate.  The available statistics
864 are:
865 @itemize
866 @item @subcmd{MEAN}
867 @cindex arithmetic mean
868       The arithmetic mean.
869 @item @subcmd{COUNT}
870       The count of the values.
871 @item @subcmd{STDDEV}
872       The standard deviation.
873 @item @subcmd{SEMEAN}
874       The standard error of the mean.
875 @item @subcmd{SUM}
876       The sum of the values.
877 @item @subcmd{MIN}
878       The minimum value.
879 @item @subcmd{MAX}
880       The maximum value.
881 @item @subcmd{RANGE}
882       The difference between the maximum and minimum values.
883 @item @subcmd{VARIANCE}
884       The variance.
885 @item @subcmd{FIRST}
886       The first value in the category.
887 @item @subcmd{LAST}
888       The last value in the category.
889 @item @subcmd{SKEW}
890       The skewness.
891 @item @subcmd{SESKEW}
892       The standard error of the skewness.
893 @item @subcmd{KURT}
894       The kurtosis
895 @item @subcmd{SEKURT}
896       The standard error of the kurtosis.
897 @item @subcmd{HARMONIC}
898 @cindex harmonic mean
899       The harmonic mean.
900 @item @subcmd{GEOMETRIC}
901 @cindex geometric mean
902       The geometric mean.
903 @end itemize
904
905 In addition, three special keywords are recognized:
906 @itemize
907 @item @subcmd{DEFAULT}
908       This is the same as @subcmd{MEAN} @subcmd{COUNT} @subcmd{STDDEV}.
909 @item @subcmd{ALL}
910       All of the above statistics will be calculated.
911 @item @subcmd{NONE}
912       No statistics will be calculated (only a summary will be shown).
913 @end itemize
914
915
916 More than one @dfn{table} can be specified in a single command. 
917 Each table is separated by a @samp{/}. For
918 example
919 @example
920 MEANS TABLES =
921       @var{c} @var{d} @var{e} BY @var{x}
922       /@var{a} @var{b} BY @var{x} @var{y}
923       /@var{f} BY @var{y} BY @var{z}.
924 @end example
925 has three tables (the @samp{TABLE =} is optional).
926 The first table has three dependent variables @var{c}, @var{d} and @var{e}
927 and a single categorical variable @var{x}.
928 The second table has two dependent variables @var{a} and @var{b}, 
929 and two categorical variables @var{x} and @var{y}.
930 The third table has a single dependent variables @var{f}
931 and a categorical variable formed by the combination of @var{y} and @var{z}.
932
933
934 By default values are omitted from the analysis only if missing values
935 (either system missing or user missing)
936 for any of the variables directly involved in their calculation are 
937 encountered.
938 This behaviour can be modified with the  @subcmd{/MISSING} subcommand.
939 Three options are possible: @subcmd{TABLE}, @subcmd{INCLUDE} and @subcmd{DEPENDENT}.
940
941 @subcmd{/MISSING = TABLE} causes cases to be dropped if any variable is missing 
942 in the table specification currently being processed, regardless of 
943 whether it is needed to calculate the statistic.
944
945 @subcmd{/MISSING = INCLUDE} says that user missing values, either in the dependent
946 variables or in the categorical variables should be taken at their face
947 value, and not excluded.
948
949 @subcmd{/MISSING = DEPENDENT} says that user missing values, in the dependent
950 variables should be taken at their face value, however cases which 
951 have user missing values for the categorical variables should be omitted 
952 from the calculation.
953
954 @node NPAR TESTS
955 @section NPAR TESTS
956
957 @vindex NPAR TESTS
958 @cindex nonparametric tests
959
960 @display 
961 NPAR TESTS
962      
963      nonparametric test subcommands
964      .
965      .
966      .
967      
968      [ /STATISTICS=@{DESCRIPTIVES@} ]
969
970      [ /MISSING=@{ANALYSIS, LISTWISE@} @{INCLUDE, EXCLUDE@} ]
971
972      [ /METHOD=EXACT [ TIMER [(@var{n})] ] ]
973 @end display
974
975 @cmd{NPAR TESTS} performs nonparametric tests. 
976 Non parametric tests make very few assumptions about the distribution of the 
977 data.
978 One or more tests may be specified by using the corresponding subcommand.
979 If the @subcmd{/STATISTICS} subcommand is also specified, then summary statistics are 
980 produces for each variable that is the subject of any test.
981
982 Certain tests may take a long time to execute, if an exact figure is required.
983 Therefore, by default asymptotic approximations are used unless the
984 subcommand @subcmd{/METHOD=EXACT} is specified.  
985 Exact tests give more accurate results, but may take an unacceptably long 
986 time to perform.  If the @subcmd{TIMER} keyword is used, it sets a maximum time,
987 after which the test will be abandoned, and a warning message printed.
988 The time, in minutes, should be specified in parentheses after the @subcmd{TIMER} keyword.
989 If the @subcmd{TIMER} keyword is given without this figure, then a default value of 5 minutes 
990 is used.
991
992
993 @menu
994 * BINOMIAL::                Binomial Test
995 * CHISQUARE::               Chisquare Test
996 * COCHRAN::                 Cochran Q Test
997 * FRIEDMAN::                Friedman Test
998 * KENDALL::                 Kendall's W Test
999 * KOLMOGOROV-SMIRNOV::      Kolmogorov Smirnov Test
1000 * KRUSKAL-WALLIS::          Kruskal-Wallis Test
1001 * MANN-WHITNEY::            Mann Whitney U Test
1002 * MCNEMAR::                 McNemar Test
1003 * MEDIAN::                  Median Test
1004 * RUNS::                    Runs Test
1005 * SIGN::                    The Sign Test
1006 * WILCOXON::                Wilcoxon Signed Ranks Test
1007 @end menu
1008
1009
1010 @node    BINOMIAL
1011 @subsection Binomial test
1012 @vindex BINOMIAL
1013 @cindex binomial test
1014
1015 @display 
1016      [ /BINOMIAL[(@var{p})]=@var{var_list}[(@var{value1}[, @var{value2})] ] ]
1017 @end display 
1018
1019 The @subcmd{/BINOMIAL} subcommand compares the observed distribution of a dichotomous 
1020 variable with that of a binomial distribution.
1021 The variable @var{p} specifies the test proportion of the binomial 
1022 distribution.  
1023 The default value of 0.5 is assumed if @var{p} is omitted.
1024
1025 If a single value appears after the variable list, then that value is
1026 used as the threshold to partition the observed values. Values less
1027 than or equal to the threshold value form the first category.  Values
1028 greater than the threshold form the second category. 
1029
1030 If two values appear after the variable list, then they will be used
1031 as the values which a variable must take to be in the respective
1032 category. 
1033 Cases for which a variable takes a value equal to neither of the specified  
1034 values, take no part in the test for that variable.
1035
1036 If no values appear, then the variable must assume dichotomous
1037 values.
1038 If more than two distinct, non-missing values for a variable
1039 under test are encountered then an error occurs.
1040
1041 If the test proportion is equal to 0.5, then a two tailed test is
1042 reported.   For any other test proportion, a one tailed test is
1043 reported.   
1044 For one tailed tests, if the test proportion is less than
1045 or equal to the observed proportion, then the significance of
1046 observing the observed proportion or more is reported.
1047 If the test proportion is more than the observed proportion, then the
1048 significance of observing the observed proportion or less is reported.
1049 That is to say, the test is always performed in the observed
1050 direction. 
1051
1052 @pspp{} uses a very precise approximation to the gamma function to
1053 compute the binomial significance.  Thus, exact results are reported
1054 even for very large sample sizes.
1055
1056
1057
1058 @node    CHISQUARE
1059 @subsection Chisquare Test
1060 @vindex CHISQUARE
1061 @cindex chisquare test
1062
1063
1064 @display
1065      [ /CHISQUARE=@var{var_list}[(@var{lo},@var{hi})] [/EXPECTED=@{EQUAL|@var{f1}, @var{f2} @dots{} @var{fn}@}] ]
1066 @end display 
1067
1068
1069 The @subcmd{/CHISQUARE} subcommand produces a chi-square statistic for the differences 
1070 between the expected and observed frequencies of the categories of a variable. 
1071 Optionally, a range of values may appear after the variable list.  
1072 If a range is given, then non integer values are truncated, and values
1073 outside the  specified range are excluded from the analysis.
1074
1075 The @subcmd{/EXPECTED} subcommand specifies the expected values of each
1076 category.  
1077 There must be exactly one non-zero expected value, for each observed
1078 category, or the @subcmd{EQUAL} keywork must be specified.
1079 You may use the notation @subcmd{@var{n}*@var{f}} to specify @var{n}
1080 consecutive expected categories all taking a frequency of @var{f}.
1081 The frequencies given are proportions, not absolute frequencies.  The
1082 sum of the frequencies need not be 1.
1083 If no @subcmd{/EXPECTED} subcommand is given, then then equal frequencies 
1084 are expected.
1085
1086
1087 @node COCHRAN
1088 @subsection Cochran Q Test
1089 @vindex Cochran
1090 @cindex Cochran Q test
1091 @cindex Q, Cochran Q
1092
1093 @display
1094      [ /COCHRAN = @var{var_list} ]
1095 @end display
1096
1097 The Cochran Q test is used to test for differences between three or more groups.
1098 The data for @var{var_list} in all cases must assume exactly two distinct values (other than missing values). 
1099
1100 The value of Q will be displayed and its Asymptotic significance based on a chi-square distribution.
1101
1102 @node FRIEDMAN
1103 @subsection Friedman Test
1104 @vindex FRIEDMAN
1105 @cindex Friedman test
1106
1107 @display
1108      [ /FRIEDMAN = @var{var_list} ]
1109 @end display
1110
1111 The Friedman test is used to test for differences between repeated measures when
1112 there is no indication that the distributions are normally distributed.
1113
1114 A list of variables which contain the measured data must be given.  The procedure
1115 prints the sum of ranks for each variable, the test statistic and its significance.
1116
1117 @node KENDALL
1118 @subsection Kendall's W Test
1119 @vindex KENDALL
1120 @cindex Kendall's W test
1121 @cindex coefficient of concordance
1122
1123 @display
1124      [ /KENDALL = @var{var_list} ]
1125 @end display
1126
1127 The Kendall test investigates whether an arbitrary number of related samples come from the 
1128 same population.
1129 It is identical to the Friedman test except that the additional statistic W, Kendall's Coefficient of Concordance is printed.
1130 It has the range [0,1] --- a value of zero indicates no agreement between the samples whereas a value of
1131 unity indicates complete agreement.
1132
1133
1134 @node KOLMOGOROV-SMIRNOV
1135 @subsection Kolmogorov-Smirnov Test
1136 @vindex KOLMOGOROV-SMIRNOV
1137 @vindex K-S
1138 @cindex Kolmogorov-Smirnov test
1139
1140 @display
1141      [ /KOLMOGOROV-SMIRNOV (@{NORMAL [@var{mu}, @var{sigma}], UNIFORM [@var{min}, @var{max}], POISSON [@var{lambda}], EXPONENTIAL [@var{scale}] @}) = @var{var_list} ]
1142 @end display
1143
1144 The one sample Kolmogorov-Smirnov subcommand is used to test whether or not a dataset is
1145 drawn from a particular distribution.  Four distributions are supported, @i{viz:}
1146 Normal, Uniform, Poisson and Exponential.
1147
1148 Ideally you should provide the parameters of the distribution against which you wish to test
1149 the data. For example, with the normal distribution  the mean (@var{mu})and standard deviation (@var{sigma})
1150 should be given; with the uniform distribution, the minimum (@var{min})and maximum (@var{max}) value should
1151 be provided.
1152 However, if the parameters are omitted they will be imputed from the data. Imputing the
1153 parameters reduces the power of the test so should be avoided if possible.
1154
1155 In the following example, two variables @var{score} and @var{age} are tested to see if
1156 they follow a normal distribution with a mean of 3.5 and a standard deviation of 2.0.
1157 @example
1158   NPAR TESTS
1159         /KOLMOGOROV-SMIRNOV (normal 3.5 2.0) = @var{score} @var{age}.
1160 @end example
1161 If the variables need to be tested against different distributions, then a separate
1162 subcommand must be used.  For example the following syntax tests @var{score} against
1163 a normal distribution with mean of 3.5 and standard deviation of 2.0 whilst @var{age}
1164 is tested against a normal distribution of mean 40 and standard deviation 1.5.
1165 @example
1166   NPAR TESTS
1167         /KOLMOGOROV-SMIRNOV (normal 3.5 2.0) = @var{score}
1168         /KOLMOGOROV-SMIRNOV (normal 40 1.5) =  @var{age}.
1169 @end example
1170
1171 The abbreviated subcommand  @subcmd{K-S} may be used in place of @subcmd{KOLMOGOROV-SMIRNOV}.
1172
1173 @node KRUSKAL-WALLIS
1174 @subsection Kruskal-Wallis Test
1175 @vindex KRUSKAL-WALLIS
1176 @vindex K-W
1177 @cindex Kruskal-Wallis test
1178
1179 @display
1180      [ /KRUSKAL-WALLIS = @var{var_list} BY var (@var{lower}, @var{upper}) ]
1181 @end display
1182
1183 The Kruskal-Wallis test is used to compare data from an 
1184 arbitrary number of populations.  It does not assume normality.
1185 The data to be compared are specified by @var{var_list}.
1186 The categorical variable determining the groups to which the
1187 data belongs is given by @var{var}. The limits @var{lower} and
1188 @var{upper} specify the valid range of @var{var}. Any cases for
1189 which @var{var} falls outside [@var{lower}, @var{upper}] will be
1190 ignored.
1191
1192 The mean rank of each group as well as the chi-squared value and significance
1193 of the test will be printed.
1194 The abbreviated subcommand  @subcmd{K-W} may be used in place of @subcmd{KRUSKAL-WALLIS}.
1195
1196
1197 @node MANN-WHITNEY
1198 @subsection Mann-Whitney U Test
1199 @vindex MANN-WHITNEY
1200 @vindex M-W
1201 @cindex Mann-Whitney U test
1202 @cindex U, Mann-Whitney U
1203
1204 @display
1205      [ /MANN-WHITNEY = @var{var_list} BY var (@var{group1}, @var{group2}) ]
1206 @end display
1207
1208 The Mann-Whitney subcommand is used to test whether two groups of data come from different populations.
1209 The variables to be tested should be specified in @var{var_list} and the grouping variable, that determines to which group the test variables belong, in @var{var}.
1210 @var{Var} may be either a string or an alpha variable.
1211 @var{Group1} and @var{group2} specify the
1212 two values of @var{var} which determine the groups of the test data.
1213 Cases for which the @var{var} value is neither @var{group1} or @var{group2} will be ignored.
1214
1215 The value of the Mann-Whitney U statistic, the Wilcoxon W, and the significance will be printed.
1216 The abbreviated subcommand  @subcmd{M-W} may be used in place of @subcmd{MANN-WHITNEY}.
1217
1218 @node MCNEMAR
1219 @subsection McNemar Test
1220 @vindex MCNEMAR
1221 @cindex McNemar test
1222
1223 @display
1224      [ /MCNEMAR @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
1225 @end display
1226
1227 Use McNemar's test to analyse the significance of the difference between
1228 pairs of correlated proportions.
1229
1230 If the @code{WITH} keyword is omitted, then tests for all
1231 combinations of the listed variables are performed.
1232 If the @code{WITH} keyword is given, and the @code{(PAIRED)} keyword
1233 is also given, then the number of variables preceding @code{WITH}
1234 must be the same as the number following it.
1235 In this case, tests for each respective pair of variables are
1236 performed.
1237 If the @code{WITH} keyword is given, but the
1238 @code{(PAIRED)} keyword is omitted, then tests for each combination
1239 of variable preceding @code{WITH} against variable following
1240 @code{WITH} are performed.
1241
1242 The data in each variable must be dichotomous.  If there are more
1243 than two distinct variables an error will occur and the test will
1244 not be run.
1245
1246 @node MEDIAN
1247 @subsection Median Test
1248 @vindex MEDIAN
1249 @cindex Median test
1250
1251 @display
1252      [ /MEDIAN [(@var{value})] = @var{var_list} BY @var{variable} (@var{value1}, @var{value2}) ]
1253 @end display
1254
1255 The median test is used to test whether independent samples come from 
1256 populations with a common median.
1257 The median of the populations against which the samples are to be tested
1258 may be given in parentheses immediately after the 
1259 @subcmd{/MEDIAN} subcommand.  If it is not given, the median will be imputed from the 
1260 union of all the samples.
1261
1262 The variables of the samples to be tested should immediately follow the @samp{=} sign. The
1263 keyword @code{BY} must come next, and then the grouping variable.  Two values
1264 in parentheses should follow.  If the first value is greater than the second,
1265 then a 2 sample test is performed using these two values to determine the groups.
1266 If however, the first variable is less than the second, then a @i{k} sample test is
1267 conducted and the group values used are all values encountered which lie in the
1268 range [@var{value1},@var{value2}].
1269
1270
1271 @node RUNS
1272 @subsection Runs Test
1273 @vindex RUNS
1274 @cindex runs test
1275
1276 @display 
1277      [ /RUNS (@{MEAN, MEDIAN, MODE, @var{value}@})  = @var{var_list} ]
1278 @end display
1279
1280 The @subcmd{/RUNS} subcommand tests whether a data sequence is randomly ordered.
1281
1282 It works by examining the number of times a variable's value crosses a given threshold. 
1283 The desired threshold must be specified within parentheses.
1284 It may either be specified as a number or as one of @subcmd{MEAN}, @subcmd{MEDIAN} or @subcmd{MODE}.
1285 Following the threshold specification comes the list of variables whose values are to be
1286 tested.
1287
1288 The subcommand shows the number of runs, the asymptotic significance based on the
1289 length of the data.
1290
1291 @node SIGN
1292 @subsection Sign Test
1293 @vindex SIGN
1294 @cindex sign test
1295
1296 @display
1297      [ /SIGN @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
1298 @end display
1299
1300 The @subcmd{/SIGN} subcommand tests for differences between medians of the 
1301 variables listed.
1302 The test does not make any assumptions about the
1303 distribution of the data.
1304
1305 If the @code{WITH} keyword is omitted, then tests for all
1306 combinations of the listed variables are performed.
1307 If the @code{WITH} keyword is given, and the @code{(PAIRED)} keyword
1308 is also given, then the number of variables preceding @code{WITH}
1309 must be the same as the number following it.
1310 In this case, tests for each respective pair of variables are
1311 performed.
1312 If the @code{WITH} keyword is given, but the
1313 @code{(PAIRED)} keyword is omitted, then tests for each combination
1314 of variable preceding @code{WITH} against variable following
1315 @code{WITH} are performed.
1316
1317 @node WILCOXON
1318 @subsection Wilcoxon Matched Pairs Signed Ranks Test
1319 @vindex WILCOXON
1320 @cindex wilcoxon matched pairs signed ranks test
1321
1322 @display
1323      [ /WILCOXON @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
1324 @end display
1325
1326 The @subcmd{/WILCOXON} subcommand tests for differences between medians of the 
1327 variables listed.
1328 The test does not make any assumptions about the variances of the samples.
1329 It does however assume that the distribution is symetrical.
1330
1331 If the @subcmd{WITH} keyword is omitted, then tests for all
1332 combinations of the listed variables are performed.
1333 If the @subcmd{WITH} keyword is given, and the @subcmd{(PAIRED)} keyword
1334 is also given, then the number of variables preceding @subcmd{WITH}
1335 must be the same as the number following it.
1336 In this case, tests for each respective pair of variables are
1337 performed.
1338 If the @subcmd{WITH} keyword is given, but the
1339 @subcmd{(PAIRED)} keyword is omitted, then tests for each combination
1340 of variable preceding @subcmd{WITH} against variable following
1341 @subcmd{WITH} are performed.
1342
1343 @node T-TEST
1344 @section T-TEST
1345
1346 @vindex T-TEST
1347
1348 @display
1349 T-TEST
1350         /MISSING=@{ANALYSIS,LISTWISE@} @{EXCLUDE,INCLUDE@}
1351         /CRITERIA=CIN(@var{confidence})
1352
1353
1354 (One Sample mode.)
1355         TESTVAL=@var{test_value}
1356         /VARIABLES=@var{var_list}
1357
1358
1359 (Independent Samples mode.)
1360         GROUPS=var(@var{value1} [, @var{value2}])
1361         /VARIABLES=@var{var_list}
1362
1363
1364 (Paired Samples mode.)
1365         PAIRS=@var{var_list} [WITH @var{var_list} [(PAIRED)] ]
1366
1367 @end display
1368
1369
1370 The @cmd{T-TEST} procedure outputs tables used in testing hypotheses about 
1371 means.  
1372 It operates in one of three modes:
1373 @itemize
1374 @item One Sample mode.
1375 @item Independent Groups mode.
1376 @item Paired mode.
1377 @end itemize
1378
1379 @noindent
1380 Each of these modes are described in more detail below.
1381 There are two optional subcommands which are common to all modes.
1382
1383 The @cmd{/CRITERIA} subcommand tells @pspp{} the confidence interval used
1384 in the tests.  The default value is 0.95.
1385
1386
1387 The @cmd{MISSING} subcommand determines the handling of missing
1388 variables.  
1389 If @subcmd{INCLUDE} is set, then user-missing values are included in the
1390 calculations, but system-missing values are not.
1391 If @subcmd{EXCLUDE} is set, which is the default, user-missing
1392 values are excluded as well as system-missing values. 
1393 This is the default.
1394
1395 If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
1396 whenever any variable  specified in the @subcmd{/VARIABLES}, @subcmd{/PAIRS} or 
1397 @subcmd{/GROUPS} subcommands contains a missing value.   
1398 If @subcmd{ANALYSIS} is set, then missing values are excluded only in the analysis for
1399 which they would be needed. This is the default.
1400
1401
1402 @menu
1403 * One Sample Mode::             Testing against a hypothesized mean
1404 * Independent Samples Mode::    Testing two independent groups for equal mean
1405 * Paired Samples Mode::         Testing two interdependent groups for equal mean
1406 @end menu
1407
1408 @node One Sample Mode
1409 @subsection One Sample Mode
1410
1411 The @subcmd{TESTVAL} subcommand invokes the One Sample mode.
1412 This mode is used to test a population mean against a hypothesized
1413 mean. 
1414 The value given to the @subcmd{TESTVAL} subcommand is the value against
1415 which you wish to test.
1416 In this mode, you must also use the @subcmd{/VARIABLES} subcommand to
1417 tell @pspp{} which variables you wish to test.
1418
1419 @node Independent Samples Mode
1420 @subsection Independent Samples Mode
1421
1422 The @subcmd{GROUPS} subcommand invokes Independent Samples mode or
1423 `Groups' mode. 
1424 This mode is used to test whether two groups of values have the
1425 same population mean.
1426 In this mode, you must also use the @subcmd{/VARIABLES} subcommand to
1427 tell @pspp{} the dependent variables you wish to test.
1428
1429 The variable given in the @subcmd{GROUPS} subcommand is the independent
1430 variable which determines to which group the samples belong.
1431 The values in parentheses are the specific values of the independent
1432 variable for each group.
1433 If the parentheses are omitted and no values are given, the default values 
1434 of 1.0 and 2.0 are assumed.
1435
1436 If the independent variable is numeric, 
1437 it is acceptable to specify only one value inside the parentheses.
1438 If you do this, cases where the independent variable is
1439 greater than or equal to this value belong to the first group, and cases
1440 less than this value belong to the second group.
1441 When using this form of the @subcmd{GROUPS} subcommand, missing values in
1442 the independent variable are excluded on a listwise basis, regardless
1443 of whether @subcmd{/MISSING=LISTWISE} was specified.
1444
1445
1446 @node Paired Samples Mode
1447 @subsection Paired Samples Mode
1448
1449 The @cmd{PAIRS} subcommand introduces Paired Samples mode.
1450 Use this mode when repeated measures have been taken from the same
1451 samples.
1452 If the @subcmd{WITH} keyword is omitted, then tables for all
1453 combinations of variables given in the @cmd{PAIRS} subcommand are
1454 generated. 
1455 If the @subcmd{WITH} keyword is given, and the @subcmd{(PAIRED)} keyword
1456 is also given, then the number of variables preceding @subcmd{WITH}
1457 must be the same as the number following it.
1458 In this case, tables for each respective pair of variables are
1459 generated.
1460 In the event that the @subcmd{WITH} keyword is given, but the
1461 @subcmd{(PAIRED)} keyword is omitted, then tables for each combination
1462 of variable preceding @subcmd{WITH} against variable following
1463 @subcmd{WITH} are generated.
1464
1465
1466 @node ONEWAY
1467 @section ONEWAY
1468
1469 @vindex ONEWAY
1470 @cindex analysis of variance
1471 @cindex ANOVA
1472
1473 @display
1474 ONEWAY
1475         [/VARIABLES = ] @var{var_list} BY @var{var}
1476         /MISSING=@{ANALYSIS,LISTWISE@} @{EXCLUDE,INCLUDE@}
1477         /CONTRAST= @var{value1} [, @var{value2}] ... [,@var{valueN}]
1478         /STATISTICS=@{DESCRIPTIVES,HOMOGENEITY@}
1479         /POSTHOC=@{BONFERRONI, GH, LSD, SCHEFFE, SIDAK, TUKEY, ALPHA ([@var{value}])@}
1480 @end display
1481
1482 The @cmd{ONEWAY} procedure performs a one-way analysis of variance of
1483 variables factored by a single independent variable.
1484 It is used to compare the means of a population
1485 divided into more than two groups. 
1486
1487 The dependent variables to be analysed should be given in the @subcmd{VARIABLES}
1488 subcommand.  
1489 The list of variables must be followed by the @subcmd{BY} keyword and
1490 the name of the independent (or factor) variable.
1491
1492 You can use the @subcmd{STATISTICS} subcommand to tell @pspp{} to display
1493 ancilliary information.  The options accepted are:
1494 @itemize
1495 @item DESCRIPTIVES
1496 Displays descriptive statistics about the groups factored by the independent
1497 variable.
1498 @item HOMOGENEITY
1499 Displays the Levene test of Homogeneity of Variance for the
1500 variables and their groups.
1501 @end itemize
1502
1503 The @subcmd{CONTRAST} subcommand is used when you anticipate certain
1504 differences between the groups.
1505 The subcommand must be followed by a list of numerals which are the
1506 coefficients of the groups to be tested.
1507 The number of coefficients must correspond to the number of distinct
1508 groups (or values of the independent variable).
1509 If the total sum of the coefficients are not zero, then @pspp{} will
1510 display a warning, but will proceed with the analysis.
1511 The @subcmd{CONTRAST} subcommand may be given up to 10 times in order
1512 to specify different contrast tests.
1513 The @subcmd{MISSING} subcommand defines how missing values are handled.
1514 If @subcmd{LISTWISE} is specified then cases which have missing values for 
1515 the independent variable or any dependent variable will be ignored.
1516 If @subcmd{ANALYSIS} is specified, then cases will be ignored if the independent
1517 variable is missing or if the dependent variable currently being 
1518 analysed is missing.  The default is @subcmd{ANALYSIS}.
1519 A setting of @subcmd{EXCLUDE} means that variables whose values are
1520 user-missing are to be excluded from the analysis. A setting of
1521 @subcmd{INCLUDE} means they are to be included.  The default is @subcmd{EXCLUDE}.
1522
1523 Using the @code{POSTHOC} subcommand you can perform multiple
1524 pairwise comparisons on the data. The following comparison methods
1525 are available:
1526 @itemize
1527 @item @subcmd{LSD}
1528 Least Significant Difference.
1529 @item @subcmd{TUKEY}
1530 Tukey Honestly Significant Difference.
1531 @item @subcmd{BONFERRONI}
1532 Bonferroni test.
1533 @item @subcmd{SCHEFFE}
1534 Scheff@'e's test.
1535 @item @subcmd{SIDAK}
1536 Sidak test.
1537 @item @subcmd{GH}
1538 The Games-Howell test.
1539 @end itemize
1540
1541 @noindent
1542 The optional syntax @code{ALPHA(@var{value})} is used to indicate
1543 that @var{value} should be used as the
1544 confidence level for which the posthoc tests will be performed.
1545 The default is 0.05.
1546
1547 @node QUICK CLUSTER
1548 @section QUICK CLUSTER
1549 @vindex QUICK CLUSTER
1550
1551 @cindex K-means clustering
1552 @cindex clustering
1553
1554 @display
1555 QUICK CLUSTER @var{var_list}
1556       [/CRITERIA=CLUSTERS(@var{k}) [MXITER(@var{max_iter})]]
1557       [/MISSING=@{EXCLUDE,INCLUDE@} @{LISTWISE, PAIRWISE@}]
1558 @end display
1559
1560 The @cmd{QUICK CLUSTER} command performs k-means clustering on the
1561 dataset.  This is useful when you wish to allocate cases into clusters
1562 of similar values and you already know the number of clusters.
1563
1564 The minimum specification is @samp{QUICK CLUSTER} followed by the names
1565 of the variables which contain the cluster data.  Normally you will also
1566 want to specify @subcmd{/CRITERIA=CLUSTERS(@var{k})} where @var{k} is the
1567 number of clusters.  If this is not given, then @var{k} defaults to 2.
1568
1569 The command uses an iterative algorithm to determine the clusters for
1570 each case.  It will continue iterating until convergence, or until @var{max_iter}
1571 iterations have been done.  The default value of @var{max_iter} is 2.
1572
1573 The @subcmd{MISSING} subcommand determines the handling of missing variables.  
1574 If @subcmd{INCLUDE} is set, then user-missing values are considered at their face
1575 value and not as missing values.
1576 If @subcmd{EXCLUDE} is set, which is the default, user-missing
1577 values are excluded as well as system-missing values. 
1578
1579 If @subcmd{LISTWISE} is set, then the entire case is excluded from the analysis
1580 whenever any of the clustering variables contains a missing value.   
1581 If @subcmd{PAIRWISE} is set, then a case is considered missing only if all the
1582 clustering variables contain missing values.  Otherwise it is clustered
1583 on the basis of the non-missing values.
1584 The default is @subcmd{LISTWISE}.
1585
1586
1587 @node RANK
1588 @section RANK
1589
1590 @vindex RANK
1591 @display
1592 RANK
1593         [VARIABLES=] @var{var_list} [@{A,D@}] [BY @var{var_list}]
1594         /TIES=@{MEAN,LOW,HIGH,CONDENSE@}
1595         /FRACTION=@{BLOM,TUKEY,VW,RANKIT@}
1596         /PRINT[=@{YES,NO@}
1597         /MISSING=@{EXCLUDE,INCLUDE@}
1598
1599         /RANK [INTO @var{var_list}]
1600         /NTILES(k) [INTO @var{var_list}]
1601         /NORMAL [INTO @var{var_list}]
1602         /PERCENT [INTO @var{var_list}]
1603         /RFRACTION [INTO @var{var_list}]
1604         /PROPORTION [INTO @var{var_list}]
1605         /N [INTO @var{var_list}]
1606         /SAVAGE [INTO @var{var_list}]
1607 @end display
1608
1609 The @cmd{RANK} command ranks variables and stores the results into new
1610 variables. 
1611
1612 The @subcmd{VARIABLES} subcommand, which is mandatory, specifies one or
1613 more variables whose values are to be ranked.  
1614 After each variable, @samp{A} or @samp{D} may appear, indicating that
1615 the variable is to be ranked in ascending or descending order.
1616 Ascending is the default.
1617 If a @subcmd{BY} keyword appears, it should be followed by a list of variables
1618 which are to serve as group variables.  
1619 In this case, the cases are gathered into groups, and ranks calculated
1620 for each group.
1621
1622 The @subcmd{TIES} subcommand specifies how tied values are to be treated.  The
1623 default is to take the mean value of all the tied cases.
1624
1625 The @subcmd{FRACTION} subcommand specifies how proportional ranks are to be
1626 calculated.  This only has any effect if @subcmd{NORMAL} or @subcmd{PROPORTIONAL} rank
1627 functions are requested.
1628
1629 The @subcmd{PRINT} subcommand may be used to specify that a summary of the rank
1630 variables created should appear in the output.
1631
1632 The function subcommands are @subcmd{RANK}, @subcmd{NTILES}, @subcmd{NORMAL}, @subcmd{PERCENT}, @subcmd{RFRACTION},
1633 @subcmd{PROPORTION} and @subcmd{SAVAGE}.  Any number of function subcommands may appear.
1634 If none are given, then the default is RANK.
1635 The @subcmd{NTILES} subcommand must take an integer specifying the number of
1636 partitions into which values should be ranked.
1637 Each subcommand may be followed by the @subcmd{INTO} keyword and a list of
1638 variables which are the variables to be created and receive the rank
1639 scores.  There may be as many variables specified as there are
1640 variables named on the @subcmd{VARIABLES} subcommand.  If fewer are specified,
1641 then the variable names are automatically created.
1642
1643 The @subcmd{MISSING} subcommand determines how user missing values are to be
1644 treated. A setting of @subcmd{EXCLUDE} means that variables whose values are
1645 user-missing are to be excluded from the rank scores. A setting of
1646 @subcmd{INCLUDE} means they are to be included.  The default is @subcmd{EXCLUDE}.
1647
1648 @include regression.texi
1649
1650
1651 @node RELIABILITY
1652 @section RELIABILITY
1653
1654 @vindex RELIABILITY
1655 @display
1656 RELIABILITY
1657         /VARIABLES=@var{var_list}
1658         /SCALE (@var{name}) = @{@var{var_list}, ALL@}
1659         /MODEL=@{ALPHA, SPLIT[(@var{n})]@}
1660         /SUMMARY=@{TOTAL,ALL@}
1661         /MISSING=@{EXCLUDE,INCLUDE@}
1662 @end display
1663
1664 @cindex Cronbach's Alpha
1665 The @cmd{RELIABILTY} command performs reliability analysis on the data.
1666
1667 The @subcmd{VARIABLES} subcommand is required. It determines the set of variables 
1668 upon which analysis is to be performed.
1669
1670 The @subcmd{SCALE} subcommand determines which variables reliability is to be 
1671 calculated for.  If it is omitted, then analysis for all variables named
1672 in the @subcmd{VARIABLES} subcommand will be used.
1673 Optionally, the @var{name} parameter may be specified to set a string name 
1674 for the scale.
1675
1676 The @subcmd{MODEL} subcommand determines the type of analysis. If @subcmd{ALPHA} is specified, 
1677 then Cronbach's Alpha is calculated for the scale.  If the model is @subcmd{SPLIT}, 
1678 then the variables  are divided into 2 subsets.  An optional parameter 
1679 @var{n} may be given, to specify how many variables to be in the first subset.
1680 If @var{n} is omitted, then it defaults to one half of the variables in the 
1681 scale, or one half minus one if there are an odd number of variables.
1682 The default model is @subcmd{ALPHA}.
1683
1684 By default, any cases with user missing, or system missing values for 
1685 any variables given 
1686 in the @subcmd{VARIABLES} subcommand will be omitted from analysis.
1687 The @subcmd{MISSING} subcommand determines whether user missing values are to 
1688 be included or excluded in the analysis.
1689
1690 The @subcmd{SUMMARY} subcommand determines the type of summary analysis to be performed.
1691 Currently there is only one type: @subcmd{SUMMARY=TOTAL}, which displays per-item
1692 analysis tested against the totals.
1693
1694
1695
1696 @node ROC
1697 @section ROC
1698
1699 @vindex ROC
1700 @cindex Receiver Operating Characteristic
1701 @cindex Area under curve
1702
1703 @display
1704 ROC     @var{var_list} BY @var{state_var} (@var{state_value})
1705         /PLOT = @{ CURVE [(REFERENCE)], NONE @}
1706         /PRINT = [ SE ] [ COORDINATES ]
1707         /CRITERIA = [ CUTOFF(@{INCLUDE,EXCLUDE@}) ]
1708           [ TESTPOS (@{LARGE,SMALL@}) ]
1709           [ CI (@var{confidence}) ]
1710           [ DISTRIBUTION (@{FREE, NEGEXPO @}) ]
1711         /MISSING=@{EXCLUDE,INCLUDE@}
1712 @end display
1713
1714
1715 The @cmd{ROC} command is used to plot the receiver operating characteristic curve 
1716 of a dataset, and to estimate the area under the curve.
1717 This is useful for analysing the efficacy of a variable as a predictor of a state of nature.
1718
1719 The mandatory @var{var_list} is the list of predictor variables.
1720 The variable @var{state_var} is the variable whose values represent the actual states, 
1721 and @var{state_value} is the value of this variable which represents the positive state.
1722
1723 The optional subcommand @subcmd{PLOT} is used to determine if and how the @subcmd{ROC} curve is drawn.
1724 The keyword @subcmd{CURVE} means that the @subcmd{ROC} curve should be drawn, and the optional keyword @subcmd{REFERENCE},
1725 which should be enclosed in parentheses, says that the diagonal reference line should be drawn.
1726 If the keyword @subcmd{NONE} is given, then no @subcmd{ROC} curve is drawn.
1727 By default, the curve is drawn with no reference line.
1728
1729 The optional subcommand @subcmd{PRINT} determines which additional tables should be printed.
1730 Two additional tables are available. 
1731 The @subcmd{SE} keyword says that standard error of the area under the curve should be printed as well as
1732 the area itself.
1733 In addition, a p-value under the null hypothesis that the area under the curve equals 0.5 will be
1734 printed.
1735 The @subcmd{COORDINATES} keyword says that a table of coordinates of the @subcmd{ROC} curve should be printed.
1736
1737 The @subcmd{CRITERIA} subcommand has four optional parameters:
1738 @itemize @bullet
1739 @item The @subcmd{TESTPOS} parameter may be @subcmd{LARGE} or @subcmd{SMALL}.
1740 @subcmd{LARGE} is the default, and says that larger values in the predictor variables are to be 
1741 considered positive.  @subcmd{SMALL} indicates that smaller values should be considered positive.
1742
1743 @item The @subcmd{CI} parameter specifies the confidence interval that should be printed.
1744 It has no effect if the @subcmd{SE} keyword in the @subcmd{PRINT} subcommand has not been given.
1745
1746 @item The @subcmd{DISTRIBUTION} parameter determines the method to be used when estimating the area
1747 under the curve.  
1748 There are two possibilities, @i{viz}: @subcmd{FREE} and @subcmd{NEGEXPO}.
1749 The @subcmd{FREE} method uses a non-parametric estimate, and the @subcmd{NEGEXPO} method a bi-negative 
1750 exponential distribution estimate.
1751 The @subcmd{NEGEXPO} method should only be used when the number of positive actual states is
1752 equal to the number of negative actual states.
1753 The default is @subcmd{FREE}.
1754
1755 @item The @subcmd{CUTOFF} parameter is for compatibility and is ignored.
1756 @end itemize
1757
1758 The @subcmd{MISSING} subcommand determines whether user missing values are to 
1759 be included or excluded in the analysis.  The default behaviour is to
1760 exclude them.
1761 Cases are excluded on a listwise basis; if any of the variables in @var{var_list} 
1762 or if the variable @var{state_var} is missing, then the entire case will be 
1763 excluded.