Docment how CLABELS can affect calculations.
[pspp] / doc / statistics.texi
1 @c PSPP - a program for statistical analysis.
2 @c Copyright (C) 2017, 2020 Free Software Foundation, Inc.
3 @c Permission is granted to copy, distribute and/or modify this document
4 @c under the terms of the GNU Free Documentation License, Version 1.3
5 @c or any later version published by the Free Software Foundation;
6 @c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
7 @c A copy of the license is included in the section entitled "GNU
8 @c Free Documentation License".
9 @c
10 @node Statistics
11 @chapter Statistics
12
13 This chapter documents the statistical procedures that @pspp{} supports so
14 far.
15
16 @menu
17 * DESCRIPTIVES::                Descriptive statistics.
18 * FREQUENCIES::                 Frequency tables.
19 * EXAMINE::                     Testing data for normality.
20 * GRAPH::                       Plot data.
21 * CORRELATIONS::                Correlation tables.
22 * CROSSTABS::                   Crosstabulation tables.
23 * CTABLES::                     Custom tables.
24 * FACTOR::                      Factor analysis and Principal Components analysis.
25 * GLM::                         Univariate Linear Models.
26 * LOGISTIC REGRESSION::         Bivariate Logistic Regression.
27 * MEANS::                       Average values and other statistics.
28 * NPAR TESTS::                  Nonparametric tests.
29 * T-TEST::                      Test hypotheses about means.
30 * ONEWAY::                      One way analysis of variance.
31 * QUICK CLUSTER::               K-Means clustering.
32 * RANK::                        Compute rank scores.
33 * RELIABILITY::                 Reliability analysis.
34 * ROC::                         Receiver Operating Characteristic.
35 @end menu
36
37 @node DESCRIPTIVES
38 @section DESCRIPTIVES
39
40 @vindex DESCRIPTIVES
41 @display
42 DESCRIPTIVES
43         /VARIABLES=@var{var_list}
44         /MISSING=@{VARIABLE,LISTWISE@} @{INCLUDE,NOINCLUDE@}
45         /FORMAT=@{LABELS,NOLABELS@} @{NOINDEX,INDEX@} @{LINE,SERIAL@}
46         /SAVE
47         /STATISTICS=@{ALL,MEAN,SEMEAN,STDDEV,VARIANCE,KURTOSIS,
48                      SKEWNESS,RANGE,MINIMUM,MAXIMUM,SUM,DEFAULT,
49                      SESKEWNESS,SEKURTOSIS@}
50         /SORT=@{NONE,MEAN,SEMEAN,STDDEV,VARIANCE,KURTOSIS,SKEWNESS,
51                RANGE,MINIMUM,MAXIMUM,SUM,SESKEWNESS,SEKURTOSIS,NAME@}
52               @{A,D@}
53 @end display
54
55 The @cmd{DESCRIPTIVES} procedure reads the active dataset and outputs
56 linear descriptive statistics requested by the user.  In addition, it can optionally
57 compute Z-scores.
58
59 The @subcmd{VARIABLES} subcommand, which is required, specifies the list of
60 variables to be analyzed.  Keyword @subcmd{VARIABLES} is optional.
61
62 All other subcommands are optional:
63
64 The @subcmd{MISSING} subcommand determines the handling of missing variables.  If
65 @subcmd{INCLUDE} is set, then user-missing values are included in the
66 calculations.  If @subcmd{NOINCLUDE} is set, which is the default, user-missing
67 values are excluded.  If @subcmd{VARIABLE} is set, then missing values are
68 excluded on a variable by variable basis; if @subcmd{LISTWISE} is set, then
69 the entire case is excluded whenever any value in that case has a
70 system-missing or, if @subcmd{INCLUDE} is set, user-missing value.
71
72 The @subcmd{FORMAT} subcommand has no effect.  It is accepted for
73 backward compatibility.
74
75 The @subcmd{SAVE} subcommand causes @cmd{DESCRIPTIVES} to calculate Z scores for all
76 the specified variables.  The Z scores are saved to new variables.
77 Variable names are generated by trying first the original variable name
78 with Z prepended and truncated to a maximum of 8 characters, then the
79 names ZSC000 through ZSC999, STDZ00 through STDZ09, ZZZZ00 through
80 ZZZZ09, ZQZQ00 through ZQZQ09, in that sequence.  In addition, Z score
81 variable names can be specified explicitly on @subcmd{VARIABLES} in the variable
82 list by enclosing them in parentheses after each variable.
83 When Z scores are calculated, @pspp{} ignores @cmd{TEMPORARY},
84 treating temporary transformations as permanent.
85
86 The @subcmd{STATISTICS} subcommand specifies the statistics to be displayed:
87
88 @table @code
89 @item @subcmd{ALL}
90 All of the statistics below.
91 @item @subcmd{MEAN}
92 Arithmetic mean.
93 @item @subcmd{SEMEAN}
94 Standard error of the mean.
95 @item @subcmd{STDDEV}
96 Standard deviation.
97 @item @subcmd{VARIANCE}
98 Variance.
99 @item @subcmd{KURTOSIS}
100 Kurtosis and standard error of the kurtosis.
101 @item @subcmd{SKEWNESS}
102 Skewness and standard error of the skewness.
103 @item @subcmd{RANGE}
104 Range.
105 @item MINIMUM
106 Minimum value.
107 @item MAXIMUM
108 Maximum value.
109 @item SUM
110 Sum.
111 @item DEFAULT
112 Mean, standard deviation of the mean, minimum, maximum.
113 @item SEKURTOSIS
114 Standard error of the kurtosis.
115 @item SESKEWNESS
116 Standard error of the skewness.
117 @end table
118
119 The @subcmd{SORT} subcommand specifies how the statistics should be sorted.  Most
120 of the possible values should be self-explanatory.  @subcmd{NAME} causes the
121 statistics to be sorted by name.  By default, the statistics are listed
122 in the order that they are specified on the @subcmd{VARIABLES} subcommand.
123 The @subcmd{A} and @subcmd{D} settings request an ascending or descending
124 sort order, respectively.
125
126 @subsection Descriptives Example
127
128 The @file{physiology.sav} file contains various physiological data for a sample
129 of persons.   Running the @cmd{DESCRIPTIVES} command on the variables @exvar{height}
130 and @exvar{temperature} with the default options allows one to see simple linear
131 statistics for these two variables.  In @ref{descriptives:ex}, these variables
132 are specfied on the @subcmd{VARIABLES} subcommand and the @subcmd{SAVE} option
133 has been used, to request that Z scores be calculated.
134
135 After the command has completed, this example runs @cmd{DESCRIPTIVES} again, this
136 time on the @exvar{zheight} and @exvar{ztemperature} variables,
137 which are the two normalized (Z-score) variables generated by the
138 first @cmd{DESCRIPTIVES} command.
139
140 @float Example, descriptives:ex
141 @psppsyntax {descriptives.sps}
142 @caption {Running two @cmd{DESCRIPTIVES} commands, one with the @subcmd{SAVE} subcommand}
143 @end float
144
145 @float Screenshot, descriptives:scr
146 @psppimage {descriptives}
147 @caption {The Descriptives dialog box with two variables and Z-Scores option selected}
148 @end float
149
150 In @ref{descriptives:res}, we can see that there are 40 valid data for each of the variables
151 and no missing values.   The mean average of the height and temperature is 16677.12
152 and 37.02 respectively.  The descriptive statistics for temperature seem reasonable.
153 However there is a very high standard deviation for @exvar{height} and a suspiciously
154 low minimum.  This is due to a data entry error in the
155 data (@pxref{Identifying incorrect data}).
156
157 In the second Descriptive Statistics command, one can see that the mean and standard
158 deviation of both Z score variables is 0 and 1 respectively.  All Z score statistics
159 should have these properties since they are normalized versions of the original scores.
160
161 @float Result, descriptives:res
162 @psppoutput {descriptives}
163 @caption {Descriptives statistics including two normalized variables (Z-scores)}
164 @end float
165
166 @node FREQUENCIES
167 @section FREQUENCIES
168
169 @vindex FREQUENCIES
170 @display
171 FREQUENCIES
172         /VARIABLES=@var{var_list}
173         /FORMAT=@{TABLE,NOTABLE,LIMIT(@var{limit})@}
174                 @{AVALUE,DVALUE,AFREQ,DFREQ@}
175         /MISSING=@{EXCLUDE,INCLUDE@}
176         /STATISTICS=@{DEFAULT,MEAN,SEMEAN,MEDIAN,MODE,STDDEV,VARIANCE,
177                      KURTOSIS,SKEWNESS,RANGE,MINIMUM,MAXIMUM,SUM,
178                      SESKEWNESS,SEKURTOSIS,ALL,NONE@}
179         /NTILES=@var{ntiles}
180         /PERCENTILES=percent@dots{}
181         /HISTOGRAM=[MINIMUM(@var{x_min})] [MAXIMUM(@var{x_max})]
182                    [@{FREQ[(@var{y_max})],PERCENT[(@var{y_max})]@}] [@{NONORMAL,NORMAL@}]
183         /PIECHART=[MINIMUM(@var{x_min})] [MAXIMUM(@var{x_max})]
184                   [@{FREQ,PERCENT@}] [@{NOMISSING,MISSING@}]
185         /BARCHART=[MINIMUM(@var{x_min})] [MAXIMUM(@var{x_max})]
186                   [@{FREQ,PERCENT@}]
187         /ORDER=@{ANALYSIS,VARIABLE@}
188
189
190 (These options are not currently implemented.)
191         /HBAR=@dots{}
192         /GROUPED=@dots{}
193 @end display
194
195 The @cmd{FREQUENCIES} procedure outputs frequency tables for specified
196 variables.
197 @cmd{FREQUENCIES} can also calculate and display descriptive statistics
198 (including median and mode) and percentiles, and various graphical representations
199 of the frequency distribution.
200
201 The @subcmd{VARIABLES} subcommand is the only required subcommand.  Specify the
202 variables to be analyzed.
203
204 The @subcmd{FORMAT} subcommand controls the output format.  It has several
205 possible settings:
206
207 @itemize @subcmd{}
208 @item
209 @subcmd{TABLE}, the default, causes a frequency table to be output for every
210 variable specified.  @subcmd{NOTABLE} prevents them from being output.  @subcmd{LIMIT}
211 with a numeric argument causes them to be output except when there are
212 more than the specified number of values in the table.
213
214 @item
215 Normally frequency tables are sorted in ascending order by value.  This
216 is @subcmd{AVALUE}.  @subcmd{DVALUE} tables are sorted in descending order by value.
217 @subcmd{AFREQ} and @subcmd{DFREQ} tables are sorted in ascending and descending order,
218 respectively, by frequency count.
219 @end itemize
220
221 The @subcmd{MISSING} subcommand controls the handling of user-missing values.
222 When @subcmd{EXCLUDE}, the default, is set, user-missing values are not included
223 in frequency tables or statistics.  When @subcmd{INCLUDE} is set, user-missing
224 are included.  System-missing values are never included in statistics,
225 but are listed in frequency tables.
226
227 The available @subcmd{STATISTICS} are the same as available
228 in @cmd{DESCRIPTIVES} (@pxref{DESCRIPTIVES}), with the addition
229 of @subcmd{MEDIAN}, the data's median
230 value, and MODE, the mode.  (If there are multiple modes, the smallest
231 value is reported.)  By default, the mean, standard deviation of the
232 mean, minimum, and maximum are reported for each variable.
233
234 @cindex percentiles
235 @subcmd{PERCENTILES} causes the specified percentiles to be reported.
236 The percentiles should  be presented at a list of numbers between 0
237 and 100 inclusive.
238 The @subcmd{NTILES} subcommand causes the percentiles to be reported at the
239 boundaries of the data set divided into the specified number of ranges.
240 For instance, @subcmd{/NTILES=4} would cause quartiles to be reported.
241
242 @cindex histogram
243 The @subcmd{HISTOGRAM} subcommand causes the output to include a histogram for
244 each specified numeric variable.  The X axis by default ranges from
245 the minimum to the maximum value observed in the data, but the @subcmd{MINIMUM}
246 and @subcmd{MAXIMUM} keywords can set an explicit range.
247 @footnote{The number of
248 bins is chosen according to the Freedman-Diaconis rule:
249 @math{2 \times IQR(x)n^{-1/3}}, where @math{IQR(x)} is the interquartile range of @math{x}
250 and @math{n} is the number of samples.    Note that
251 @cmd{EXAMINE} uses a different algorithm to determine bin sizes.}
252 Histograms are not created for string variables.
253
254 Specify @subcmd{NORMAL} to superimpose a normal curve on the
255 histogram.
256
257 @cindex piechart
258 The @subcmd{PIECHART} subcommand adds a pie chart for each variable to the data.  Each
259 slice represents one value, with the size of the slice proportional to
260 the value's frequency.  By default, all non-missing values are given
261 slices.
262 The @subcmd{MINIMUM} and @subcmd{MAXIMUM} keywords can be used to limit the
263 displayed slices to a given range of values.
264 The keyword @subcmd{NOMISSING} causes missing values to be omitted from the
265 piechart.  This is the default.
266 If instead, @subcmd{MISSING} is specified, then the pie chart includes
267 a single slice representing all system missing and user-missing cases.
268
269 @cindex bar chart
270 The @subcmd{BARCHART} subcommand produces a bar chart for each variable.
271 The @subcmd{MINIMUM} and @subcmd{MAXIMUM} keywords can be used to omit
272 categories whose counts which lie outside the specified limits.
273 The @subcmd{FREQ} option (default) causes the ordinate to display the frequency
274 of each category, whereas the @subcmd{PERCENT} option displays relative
275 percentages.
276
277 The @subcmd{FREQ} and @subcmd{PERCENT} options on @subcmd{HISTOGRAM} and
278 @subcmd{PIECHART} are accepted but not currently honoured.
279
280 The @subcmd{ORDER} subcommand is accepted but ignored.
281
282 @subsection Frequencies Example
283
284 @ref{frequencies:ex} runs a frequency analysis on the @exvar{sex}
285 and @exvar{occupation} variables from the @file{personnel.sav} file.
286 This is useful to get an general idea of the way in which these nominal
287 variables are distributed.
288
289 @float Example, frequencies:ex
290 @psppsyntax {frequencies.sps}
291 @caption {Running frequencies on the @exvar{sex} and @exvar{occupation} variables}
292 @end float
293
294 If you are using the graphic user interface, the dialog box is set up such that
295 by default, several statistics are calculated.   Some are not particularly useful
296 for categorical variables, so you may want to disable those.
297
298 @float Screenshot, frequencies:scr
299 @psppimage {frequencies}
300 @caption {The frequencies dialog box with the @exvar{sex} and @exvar{occupation} variables selected}
301 @end float
302
303 From @ref{frequencies:res} it is evident that there are 33 males, 21 females and
304 2 persons for whom their sex has not been entered.
305
306 One can also see how many of each occupation there are in the data.
307 When dealing with string variables used as nominal values, running a frequency
308 analysis is useful to detect data input entries.  Notice that
309 one @exvar{occupation} value has been mistyped as ``Scrientist''.  This entry should
310 be corrected, or marked as missing before using the data.
311
312 @float Result, frequencies:res
313 @psppoutput {frequencies}
314 @caption {The relative frequencies of @exvar{sex} and @exvar{occupation}}
315 @end float
316
317 @node EXAMINE
318 @section EXAMINE
319
320 @vindex EXAMINE
321 @cindex Exploratory data analysis
322 @cindex normality, testing
323
324 @display
325 EXAMINE
326         VARIABLES= @var{var1} [@var{var2}] @dots{} [@var{varN}]
327            [BY @var{factor1} [BY @var{subfactor1}]
328              [ @var{factor2} [BY @var{subfactor2}]]
329              @dots{}
330              [ @var{factor3} [BY @var{subfactor3}]]
331             ]
332         /STATISTICS=@{DESCRIPTIVES, EXTREME[(@var{n})], ALL, NONE@}
333         /PLOT=@{BOXPLOT, NPPLOT, HISTOGRAM, SPREADLEVEL[(@var{t})], ALL, NONE@}
334         /CINTERVAL @var{p}
335         /COMPARE=@{GROUPS,VARIABLES@}
336         /ID=@var{identity_variable}
337         /@{TOTAL,NOTOTAL@}
338         /PERCENTILE=[@var{percentiles}]=@{HAVERAGE, WAVERAGE, ROUND, AEMPIRICAL, EMPIRICAL @}
339         /MISSING=@{LISTWISE, PAIRWISE@} [@{EXCLUDE, INCLUDE@}]
340                 [@{NOREPORT,REPORT@}]
341
342 @end display
343
344 The @cmd{EXAMINE} command is used to perform exploratory data analysis.
345 In particular, it is useful for testing how closely a distribution follows a
346 normal distribution, and for finding outliers and extreme values.
347
348 The @subcmd{VARIABLES} subcommand is mandatory.
349 It specifies the dependent variables and optionally variables to use as
350 factors for the analysis.
351 Variables listed before the first @subcmd{BY} keyword (if any) are the
352 dependent variables.
353 The dependent variables may optionally be followed by a list of
354 factors which tell @pspp{} how to break down the analysis for each
355 dependent variable.
356
357 Following the dependent variables, factors may be specified.
358 The factors (if desired) should be preceded by a single @subcmd{BY} keyword.
359 The format for each factor is
360 @display
361 @var{factorvar} [BY @var{subfactorvar}].
362 @end display
363 Each unique combination of the values of  @var{factorvar} and
364 @var{subfactorvar} divide the dataset into @dfn{cells}.
365 Statistics are calculated for each cell
366 and for the entire dataset (unless @subcmd{NOTOTAL} is given).
367
368 The @subcmd{STATISTICS} subcommand specifies which statistics to show.
369 @subcmd{DESCRIPTIVES} produces a table showing some parametric and
370 non-parametrics statistics.
371 @subcmd{EXTREME} produces a table showing the extremities of each cell.
372 A number in parentheses, @var{n} determines
373 how many upper and lower extremities to show.
374 The default number is 5.
375
376 The subcommands @subcmd{TOTAL} and @subcmd{NOTOTAL} are mutually exclusive.
377 If @subcmd{TOTAL} appears, then statistics for the entire dataset
378 as well as for each cell are produced.
379 If @subcmd{NOTOTAL} appears, then statistics are produced only for the cells
380 (unless no factor variables have been given).
381 These subcommands have no effect if there have  been no factor variables
382 specified.
383
384 @cindex boxplot
385 @cindex histogram
386 @cindex npplot
387 @cindex spreadlevel plot
388 The @subcmd{PLOT} subcommand specifies which plots are to be produced if any.
389 Available plots are @subcmd{HISTOGRAM}, @subcmd{NPPLOT},  @subcmd{BOXPLOT} and
390 @subcmd{SPREADLEVEL}.
391 The first three can be used to visualise how closely each cell conforms to a
392 normal distribution, whilst the spread vs.@: level plot can be useful to visualise
393 how the variance differs between factors.
394 Boxplots show you the outliers and extreme values.
395 @footnote{@subcmd{HISTOGRAM} uses Sturges' rule to determine the number of
396 bins, as approximately @math{1 + \log2(n)}, where @math{n} is the number of samples.
397 Note that @cmd{FREQUENCIES} uses a different algorithm to find the bin size.}
398
399 The @subcmd{SPREADLEVEL} plot displays the interquartile range versus the
400 median.  It takes an optional parameter @var{t}, which specifies how the data
401 should be transformed prior to plotting.
402 The given value @var{t} is a power to which the data are raised.  For example, if
403 @var{t} is given as 2, then the square of the data is used.
404 Zero, however is a special value.  If @var{t} is 0 or
405 is omitted, then data are transformed by taking its natural logarithm instead of
406 raising to the power of @var{t}.
407
408 @cindex Shapiro-Wilk
409 When one or more plots are requested, @subcmd{EXAMINE} also performs the
410 Shapiro-Wilk test for each category.
411 There are however a number of provisos:
412 @itemize
413 @item All weight values must be integer.
414 @item The cumulative weight value must be in the range [3, 5000]
415 @end itemize
416
417 The @subcmd{COMPARE} subcommand is only relevant if producing boxplots, and it is only
418 useful there is more than one dependent variable and at least one factor.
419 If
420 @subcmd{/COMPARE=GROUPS} is specified, then one plot per dependent variable is produced,
421 each of which contain boxplots for all the cells.
422 If @subcmd{/COMPARE=VARIABLES} is specified, then one plot per cell is produced,
423 each containing one boxplot per dependent variable.
424 If the @subcmd{/COMPARE} subcommand is omitted, then @pspp{} behaves as if
425 @subcmd{/COMPARE=GROUPS} were given.
426
427 The @subcmd{ID} subcommand is relevant only if @subcmd{/PLOT=BOXPLOT} or
428 @subcmd{/STATISTICS=EXTREME} has been given.
429 If given, it should provide the name of a variable which is to be used
430 to labels extreme values and outliers.
431 Numeric or string variables are permissible.
432 If the @subcmd{ID} subcommand is not given, then the case number is used for
433 labelling.
434
435 The @subcmd{CINTERVAL} subcommand specifies the confidence interval to use in
436 calculation of the descriptives command.  The default is 95%.
437
438 @cindex percentiles
439 The @subcmd{PERCENTILES} subcommand specifies which percentiles are to be calculated,
440 and which algorithm to use for calculating them.  The default is to
441 calculate the 5, 10, 25, 50, 75, 90, 95 percentiles using the
442 @subcmd{HAVERAGE} algorithm.
443
444 The @subcmd{TOTAL} and @subcmd{NOTOTAL} subcommands are mutually exclusive.  If @subcmd{NOTOTAL}
445 is given and factors have been specified in the @subcmd{VARIABLES} subcommand,
446 then statistics for the unfactored dependent variables are
447 produced in addition to the factored variables.  If there are no
448 factors specified then @subcmd{TOTAL} and @subcmd{NOTOTAL} have no effect.
449
450
451 The following example generates descriptive statistics and histograms for
452 two variables @var{score1} and @var{score2}.
453 Two factors are given, @i{viz}: @var{gender} and @var{gender} BY @var{culture}.
454 Therefore, the descriptives and histograms are generated for each
455 distinct  value
456 of @var{gender} @emph{and} for each distinct combination of the values
457 of @var{gender} and @var{race}.
458 Since the @subcmd{NOTOTAL} keyword is given, statistics and histograms for
459 @var{score1} and @var{score2} covering the  whole dataset are not produced.
460 @example
461 EXAMINE @var{score1} @var{score2} BY
462         @var{gender}
463         @var{gender} BY @var{culture}
464         /STATISTICS = DESCRIPTIVES
465         /PLOT = HISTOGRAM
466         /NOTOTAL.
467 @end example
468
469 Here is a second example showing how the @cmd{examine} command can be used to find extremities.
470 @example
471 EXAMINE @var{height} @var{weight} BY
472         @var{gender}
473         /STATISTICS = EXTREME (3)
474         /PLOT = BOXPLOT
475         /COMPARE = GROUPS
476         /ID = @var{name}.
477 @end example
478 In this example, we look at the height and weight of a sample of individuals and
479 how they differ between male and female.
480 A table showing the 3 largest and the 3 smallest values of @exvar{height} and
481 @exvar{weight} for each gender, and for the whole dataset as are shown.
482 In addition, the @subcmd{/PLOT} subcommand requests boxplots.
483 Because @subcmd{/COMPARE = GROUPS} was specified, boxplots for male and female are
484 shown in juxtaposed in the same graphic, allowing us to easily see the difference between
485 the genders.
486 Since the variable @var{name} was specified on the @subcmd{ID} subcommand,
487 values of the @var{name} variable are used to label the extreme values.
488
489 @strong{Warning!}
490 If you specify many dependent variables or factor variables
491 for which there are many distinct values, then @cmd{EXAMINE} will produce a very
492 large quantity of output.
493
494 @node GRAPH
495 @section GRAPH
496
497 @vindex GRAPH
498 @cindex Exploratory data analysis
499 @cindex normality, testing
500
501 @display
502 GRAPH
503         /HISTOGRAM [(NORMAL)]= @var{var}
504         /SCATTERPLOT [(BIVARIATE)] = @var{var1} WITH @var{var2} [BY @var{var3}]
505         /BAR = @{@var{summary-function}(@var{var1}) | @var{count-function}@} BY @var{var2} [BY @var{var3}]
506         [ /MISSING=@{LISTWISE, VARIABLE@} [@{EXCLUDE, INCLUDE@}] ]
507                 [@{NOREPORT,REPORT@}]
508
509 @end display
510
511 The @cmd{GRAPH} command produces graphical plots of data. Only one of the subcommands
512 @subcmd{HISTOGRAM}, @subcmd{BAR} or @subcmd{SCATTERPLOT} can be specified, @i{i.e.} only one plot
513 can be produced per call of @cmd{GRAPH}. The @subcmd{MISSING} is optional.
514
515 @menu
516 * SCATTERPLOT::             Cartesian Plots
517 * HISTOGRAM::               Histograms
518 * BAR CHART::               Bar Charts
519 @end menu
520
521 @node SCATTERPLOT
522 @subsection Scatterplot
523 @cindex scatterplot
524
525 The subcommand @subcmd{SCATTERPLOT} produces an xy plot of the
526 data.
527 @cmd{GRAPH} uses the third variable @var{var3}, if specified, to determine
528 the colours and/or markers for the plot.
529 The following is an example for producing a scatterplot.
530
531 @example
532 GRAPH
533         /SCATTERPLOT = @var{height} WITH @var{weight} BY @var{gender}.
534 @end example
535
536 This example produces a scatterplot where @var{height} is plotted versus @var{weight}. Depending
537 on the value of the @var{gender} variable, the colour of the datapoint is different. With
538 this plot it is possible to analyze gender differences for @var{height} versus @var{weight} relation.
539
540 @node HISTOGRAM
541 @subsection Histogram
542 @cindex histogram
543
544 The subcommand @subcmd{HISTOGRAM} produces a histogram. Only one variable is allowed for
545 the histogram plot.
546 The keyword @subcmd{NORMAL} may be specified in parentheses, to indicate that the ideal normal curve
547 should be superimposed over the histogram.
548 For an alternative method to produce histograms @pxref{EXAMINE}. The
549 following example produces a histogram plot for the variable @var{weight}.
550
551 @example
552 GRAPH
553         /HISTOGRAM = @var{weight}.
554 @end example
555
556 @node BAR CHART
557 @subsection Bar Chart
558 @cindex bar chart
559
560 The subcommand @subcmd{BAR} produces a bar chart.
561 This subcommand requires that a @var{count-function} be specified (with no arguments) or a @var{summary-function} with a variable @var{var1} in parentheses.
562 Following the summary or count function, the keyword @subcmd{BY} should be specified and then a catagorical variable, @var{var2}.
563 The values of the variable @var{var2} determine the labels of the bars to be plotted.
564 Optionally a second categorical variable @var{var3} may be specified in which case a clustered (grouped) bar chart is produced.
565
566 Valid count functions are
567 @table @subcmd
568 @item COUNT
569 The weighted counts of the cases in each category.
570 @item PCT
571 The weighted counts of the cases in each category expressed as a percentage of the total weights of the cases.
572 @item CUFREQ
573 The cumulative weighted counts of the cases in each category.
574 @item CUPCT
575 The cumulative weighted counts of the cases in each category expressed as a percentage of the total weights of the cases.
576 @end table
577
578 The summary function is applied to @var{var1} across all cases in each category.
579 The recognised summary functions are:
580 @table @subcmd
581 @item SUM
582 The sum.
583 @item MEAN
584 The arithmetic mean.
585 @item MAXIMUM
586 The maximum value.
587 @item MINIMUM
588 The minimum value.
589 @end table
590
591 The following examples assume a dataset which is the results of a survey.
592 Each respondent has indicated annual income, their sex and city of residence.
593 One could create a bar chart showing how the mean income varies between of residents of different cities, thus:
594 @example
595 GRAPH  /BAR  = MEAN(@var{income}) BY @var{city}.
596 @end example
597
598 This can be extended to also indicate how income in each city differs between the sexes.
599 @example
600 GRAPH  /BAR  = MEAN(@var{income}) BY @var{city} BY @var{sex}.
601 @end example
602
603 One might also want to see how many respondents there are from each city.  This can be achieved as follows:
604 @example
605 GRAPH  /BAR  = COUNT BY @var{city}.
606 @end example
607
608 Bar charts can also be produced using the @ref{FREQUENCIES} and @ref{CROSSTABS} commands.
609
610 @node CORRELATIONS
611 @section CORRELATIONS
612
613 @vindex CORRELATIONS
614 @display
615 CORRELATIONS
616      /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
617      [
618       .
619       .
620       .
621       /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
622       /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
623      ]
624
625      [ /PRINT=@{TWOTAIL, ONETAIL@} @{SIG, NOSIG@} ]
626      [ /STATISTICS=DESCRIPTIVES XPROD ALL]
627      [ /MISSING=@{PAIRWISE, LISTWISE@} @{INCLUDE, EXCLUDE@} ]
628 @end display
629
630 @cindex correlation
631 The @cmd{CORRELATIONS} procedure produces tables of the Pearson correlation coefficient
632 for a set of variables.  The significance of the coefficients are also given.
633
634 At least one @subcmd{VARIABLES} subcommand is required. If you specify the @subcmd{WITH}
635 keyword, then a non-square correlation table is produced.
636 The variables preceding @subcmd{WITH}, are used as the rows of the table,
637 and the variables following @subcmd{WITH} are used as the columns of the table.
638 If no @subcmd{WITH} subcommand is specified, then @cmd{CORRELATIONS} produces a
639 square, symmetrical table using all variables.
640
641 The @cmd{MISSING} subcommand determines the handling of missing variables.
642 If @subcmd{INCLUDE} is set, then user-missing values are included in the
643 calculations, but system-missing values are not.
644 If @subcmd{EXCLUDE} is set, which is the default, user-missing
645 values are excluded as well as system-missing values.
646
647 If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
648 whenever any variable  specified in any @cmd{/VARIABLES} subcommand
649 contains a missing value.
650 If @subcmd{PAIRWISE} is set, then a case is considered missing only if either of the
651 values  for the particular coefficient are missing.
652 The default is @subcmd{PAIRWISE}.
653
654 The @subcmd{PRINT} subcommand is used to control how the reported significance values are printed.
655 If the @subcmd{TWOTAIL} option is used, then a two-tailed test of significance is
656 printed.  If the @subcmd{ONETAIL} option is given, then a one-tailed test is used.
657 The default is @subcmd{TWOTAIL}.
658
659 If the @subcmd{NOSIG} option is specified, then correlation coefficients with significance less than
660 0.05 are highlighted.
661 If @subcmd{SIG} is specified, then no highlighting is performed.  This is the default.
662
663 @cindex covariance
664 The @subcmd{STATISTICS} subcommand requests additional statistics to be displayed.  The keyword
665 @subcmd{DESCRIPTIVES} requests that the mean, number of non-missing cases, and the non-biased
666 estimator of the standard deviation are displayed.
667 These statistics are displayed in a separated table, for all the variables listed
668 in any @subcmd{/VARIABLES} subcommand.
669 The @subcmd{XPROD} keyword requests cross-product deviations and covariance estimators to
670 be displayed for each pair of variables.
671 The keyword @subcmd{ALL} is the union of @subcmd{DESCRIPTIVES} and @subcmd{XPROD}.
672
673 @node CROSSTABS
674 @section CROSSTABS
675
676 @vindex CROSSTABS
677 @display
678 CROSSTABS
679         /TABLES=@var{var_list} BY @var{var_list} [BY @var{var_list}]@dots{}
680         /MISSING=@{TABLE,INCLUDE,REPORT@}
681         /FORMAT=@{TABLES,NOTABLES@}
682                 @{AVALUE,DVALUE@}
683         /CELLS=@{COUNT,ROW,COLUMN,TOTAL,EXPECTED,RESIDUAL,SRESIDUAL,
684                 ASRESIDUAL,ALL,NONE@}
685         /COUNT=@{ASIS,CASE,CELL@}
686                @{ROUND,TRUNCATE@}
687         /STATISTICS=@{CHISQ,PHI,CC,LAMBDA,UC,BTAU,CTAU,RISK,GAMMA,D,
688                      KAPPA,ETA,CORR,ALL,NONE@}
689         /BARCHART
690
691 (Integer mode.)
692         /VARIABLES=@var{var_list} (@var{low},@var{high})@dots{}
693 @end display
694
695 The @cmd{CROSSTABS} procedure displays crosstabulation
696 tables requested by the user.  It can calculate several statistics for
697 each cell in the crosstabulation tables.  In addition, a number of
698 statistics can be calculated for each table itself.
699
700 The @subcmd{TABLES} subcommand is used to specify the tables to be reported.  Any
701 number of dimensions is permitted, and any number of variables per
702 dimension is allowed.  The @subcmd{TABLES} subcommand may be repeated as many
703 times as needed.  This is the only required subcommand in @dfn{general
704 mode}.
705
706 Occasionally, one may want to invoke a special mode called @dfn{integer
707 mode}.  Normally, in general mode, @pspp{} automatically determines
708 what values occur in the data.  In integer mode, the user specifies the
709 range of values that the data assumes.  To invoke this mode, specify the
710 @subcmd{VARIABLES} subcommand, giving a range of data values in parentheses for
711 each variable to be used on the @subcmd{TABLES} subcommand.  Data values inside
712 the range are truncated to the nearest integer, then assigned to that
713 value.  If values occur outside this range, they are discarded.  When it
714 is present, the @subcmd{VARIABLES} subcommand must precede the @subcmd{TABLES}
715 subcommand.
716
717 In general mode, numeric and string variables may be specified on
718 TABLES.  In integer mode, only numeric variables are allowed.
719
720 The @subcmd{MISSING} subcommand determines the handling of user-missing values.
721 When set to @subcmd{TABLE}, the default, missing values are dropped on a table by
722 table basis.  When set to @subcmd{INCLUDE}, user-missing values are included in
723 tables and statistics.  When set to @subcmd{REPORT}, which is allowed only in
724 integer mode, user-missing values are included in tables but marked with
725 a footnote and excluded from statistical calculations.
726
727 The @subcmd{FORMAT} subcommand controls the characteristics of the
728 crosstabulation tables to be displayed.  It has a number of possible
729 settings:
730
731 @itemize @w{}
732 @item
733 @subcmd{TABLES}, the default, causes crosstabulation tables to be output.
734 @subcmd{NOTABLES}, which is equivalent to @code{CELLS=NONE}, suppresses them.
735
736 @item
737 @subcmd{AVALUE}, the default, causes values to be sorted in ascending order.
738 @subcmd{DVALUE} asserts a descending sort order.
739 @end itemize
740
741 The @subcmd{CELLS} subcommand controls the contents of each cell in the displayed
742 crosstabulation table.  The possible settings are:
743
744 @table @asis
745 @item COUNT
746 Frequency count.
747 @item ROW
748 Row percent.
749 @item COLUMN
750 Column percent.
751 @item TOTAL
752 Table percent.
753 @item EXPECTED
754 Expected value.
755 @item RESIDUAL
756 Residual.
757 @item SRESIDUAL
758 Standardized residual.
759 @item ASRESIDUAL
760 Adjusted standardized residual.
761 @item ALL
762 All of the above.
763 @item NONE
764 Suppress cells entirely.
765 @end table
766
767 @samp{/CELLS} without any settings specified requests @subcmd{COUNT}, @subcmd{ROW},
768 @subcmd{COLUMN}, and @subcmd{TOTAL}.
769 If @subcmd{CELLS} is not specified at all then only @subcmd{COUNT}
770 is selected.
771
772 By default, crosstabulation and statistics use raw case weights,
773 without rounding.  Use the @subcmd{/COUNT} subcommand to perform
774 rounding: CASE rounds the weights of individual weights as cases are
775 read, CELL rounds the weights of cells within each crosstabulation
776 table after it has been constructed, and ASIS explicitly specifies the
777 default non-rounding behavior.  When rounding is requested, ROUND, the
778 default, rounds to the nearest integer and TRUNCATE rounds toward
779 zero.
780
781 The @subcmd{STATISTICS} subcommand selects statistics for computation:
782
783 @table @asis
784 @item CHISQ
785 @cindex chi-square
786
787 Pearson chi-square, likelihood ratio, Fisher's exact test, continuity
788 correction, linear-by-linear association.
789 @item PHI
790 Phi.
791 @item CC
792 Contingency coefficient.
793 @item LAMBDA
794 Lambda.
795 @item UC
796 Uncertainty coefficient.
797 @item BTAU
798 Tau-b.
799 @item CTAU
800 Tau-c.
801 @item RISK
802 Risk estimate.
803 @item GAMMA
804 Gamma.
805 @item D
806 Somers' D.
807 @item KAPPA
808 Cohen's Kappa.
809 @item ETA
810 Eta.
811 @item CORR
812 Spearman correlation, Pearson's r.
813 @item ALL
814 All of the above.
815 @item NONE
816 No statistics.
817 @end table
818
819 Selected statistics are only calculated when appropriate for the
820 statistic.  Certain statistics require tables of a particular size, and
821 some statistics are calculated only in integer mode.
822
823 @samp{/STATISTICS} without any settings selects CHISQ.  If the
824 @subcmd{STATISTICS} subcommand is not given, no statistics are calculated.
825
826 @cindex bar chart
827 The @samp{/BARCHART} subcommand produces a clustered bar chart for the first two
828 variables on each table.
829 If a table has more than two variables, the counts for the third and subsequent levels
830 are aggregated and the chart is produced as if there were only two variables.
831
832
833 @strong{Please note:} Currently the implementation of @cmd{CROSSTABS} has the
834 following limitations:
835
836 @itemize @bullet
837 @item
838 Significance of some symmetric and directional measures is not calculated.
839 @item
840 Asymptotic standard error is not calculated for
841 Goodman and Kruskal's tau or symmetric Somers' d.
842 @item
843 Approximate T is not calculated for symmetric uncertainty coefficient.
844 @end itemize
845
846 Fixes for any of these deficiencies would be welcomed.
847
848 @subsection Crosstabs Example
849
850 @cindex chi-square test of independence
851
852 A researcher wishes to know if, in an industry, a person's sex is related to
853 the person's occupation.  To investigate this, she has determined that the
854 @file{personnel.sav} is a representative, randomly selected sample of persons.
855 The researcher's null hypothesis is that a person's sex has no relation to a
856 person's occupation. She uses a chi-squared test of independence to investigate
857 the hypothesis.
858
859 @float Example, crosstabs:ex
860 @psppsyntax {crosstabs.sps}
861 @caption {Running crosstabs on the @exvar{sex} and @exvar{occupation} variables}
862 @end float
863
864 The syntax in @ref{crosstabs:ex} conducts a chi-squared test of independence.
865 The line @code{/tables = occupation by sex} indicates that @exvar{occupation}
866 and @exvar{sex} are the variables to be tabulated.  To do this using the @gui{}
867 you must place these variable names respectively in the @samp{Row} and
868 @samp{Column} fields as shown in @ref{crosstabs:scr}.
869
870 @float Screenshot, crosstabs:scr
871 @psppimage {crosstabs}
872 @caption {The Crosstabs dialog box with the @exvar{sex} and @exvar{occupation} variables selected}
873 @end float
874
875 Similarly, the @samp{Cells} button shows a dialog box to select the @code{count}
876 and @code{expected} options.  All other cell options can be deselected for this
877 test.
878
879 You would use the @samp{Format} and @samp{Statistics}  buttons to select options
880 for the @subcmd{FORMAT} and @subcmd{STATISTICS} subcommands.  In this example,
881 the @samp{Statistics} requires only the @samp{Chisq} option to be checked.  All
882 other options should be unchecked.  No special settings are required from the
883 @samp{Format} dialog.
884
885 As shown in @ref{crosstabs:res} @cmd{CROSSTABS} generates a contingency table
886 containing the observed count and the expected count of each sex and each
887 occupation.  The expected count is the count which would be observed if the
888 null hypothesis were true.
889
890 The significance of the Pearson Chi-Square value is very much larger than the
891 normally accepted value of 0.05 and so one cannot reject the null hypothesis.
892 Thus the researcher must conclude that a person's sex has no relation to the
893 person's occupation.
894
895 @float Results, crosstabs:res
896 @psppoutput {crosstabs}
897 @caption {The results of a test of independence between @exvar{sex} and @exvar{occupation}}
898 @end float
899
900 @node CTABLES
901 @section CTABLES
902
903 @vindex CTABLES
904 @cindex custom tables
905 @cindex tables, custom
906
907 @code{CTABLES} has the following overall syntax.  At least one
908 @code{TABLE} subcommand is required:
909
910 @display
911 @t{CTABLES}
912   @dots{}@i{global subcommands}@dots{}
913   [@t{/TABLE} @i{axis} [@t{BY} @i{axis} [@t{BY} @i{axis}]]
914    @dots{}@i{per-table subcommands}@dots{}]@dots{}
915 @end display
916
917 @noindent
918 where each @i{axis} may be empty or take one of the following forms:
919
920 @display
921 @i{variable}
922 @i{variable} @t{[}@{@t{C} @math{|} @t{S}@}@t{]}
923 @i{axis} + @i{axis}
924 @i{axis} > @i{axis}
925 (@i{axis})
926 @i{axis} @t{[}@i{summary} [@i{string}] [@i{format}]@t{]}
927 @end display
928
929 The following subcommands precede the first @code{TABLE} subcommand
930 and apply to all of the output tables.  All of these subcommands are
931 optional:
932
933 @display
934 @t{/FORMAT}
935     [@t{MINCOLWIDTH=}@{@t{DEFAULT} @math{|} @i{width}@}]
936     [@t{MAXCOLWIDTH=}@{@t{DEFAULT} @math{|} @i{width}@}]
937     [@t{UNITS=}@{@t{POINTS} @math{|} @t{INCHES} @math{|} @t{CM}@}]
938     [@t{EMPTY=}@{@t{ZERO} @math{|} @t{BLANK} @math{|} @i{string}@}]
939     [@t{MISSING=}@i{string}]
940 @t{/VLABELS}
941     @t{VARIABLES=}@i{variables}
942     @t{DISPLAY}=@{@t{DEFAULT} @math{|} @t{NAME} @math{|} @t{LABEL} @math{|} @t{BOTH} @math{|} @t{NONE}@}
943 @ignore @c not yet implemented
944 @t{/MRSETS COUNTDUPLICATES=}@{@t{YES} @math{|} @t{NO}@}
945 @end ignore
946 @t{/SMISSING} @{@t{VARIABLE} @math{|} @t{LISTWISE}@}
947 @t{/PCOMPUTE} @t{&}@i{postcompute}@t{=EXPR(}@i{expression}@t{)}
948 @t{/PPROPERTIES} @t{&}@i{postcompute}@dots{}
949     [@t{LABEL=}@i{string}]
950     [@t{FORMAT=}[@i{summary} @i{format}]@dots{}]
951     [@t{HIDESOURCECATS=}@{@t{NO} @math{|} @t{YES}@}
952 @t{/WEIGHT VARIABLE=}@i{variable}
953 @t{/HIDESMALLCOUNTS COUNT=@i{count}}
954 @end display
955
956 The following subcommands follow @code{TABLE} and apply only to the
957 previous @code{TABLE}.  All of these subcommands are optional:
958
959 @display
960 @t{/SLABELS}
961     [@t{POSITION=}@{@t{COLUMN} @math{|} @t{ROW} @math{|} @t{LAYER}@}]
962     [@t{VISIBLE=}@{@t{YES} @math{|} @t{NO}@}]
963 @t{/CLABELS} @{@t{AUTO} @math{|} @{@t{ROWLABELS}@math{|}@t{COLLABELS}@}@t{=}@{@t{OPPOSITE}@math{|}@t{LAYER}@}@}
964 @t{/CATEGORIES} @t{VARIABLES=}@i{variables}
965     @{@t{[}@i{value}@t{,} @i{value}@dots{}@t{]}
966    @math{|} [@t{ORDER=}@{@t{A} @math{|} @t{D}@}]
967      [@t{KEY=}@{@t{VALUE} @math{|} @t{LABEL} @math{|} @i{summary}@t{(}@i{variable}@t{)}@}]
968      [@t{MISSING=}@{@t{EXCLUDE} @math{|} @t{INCLUDE}@}]@}
969     [@t{TOTAL=}@{@t{NO} @math{|} @t{YES}@} [@t{LABEL=}@i{string}] [@t{POSITION=}@{@t{AFTER} @math{|} @t{BEFORE}@}]]
970     [@t{EMPTY=}@{@t{INCLUDE} @math{|} @t{EXCLUDE}@}]
971 @t{/TITLES}
972     [@t{TITLE=}@i{string}@dots{}]
973     [@t{CAPTION=}@i{string}@dots{}]
974     [@t{CORNER=}@i{string}@dots{}]
975 @ignore  @c not yet implemented
976 @t{/CRITERIA CILEVEL=}@i{percentage}
977 @t{/SIGTEST TYPE=CHISQUARE}
978     [@t{ALPHA=}@i{siglevel}]
979     [@t{INCLUDEMRSETS=}@{@t{YES} @math{|} @t{NO}@}]
980     [@t{CATEGORIES=}@{@t{ALLVISIBLE} @math{|} @t{SUBTOTALS}@}]
981 @t{/COMPARETEST TYPE=}@{@t{PROP} @math{|} @t{MEAN}@}
982     [@t{ALPHA=}@i{value}[@t{,} @i{value}]]
983     [@t{ADJUST=}@{@t{BONFERRONI} @math{|} @t{BH} @math{|} @t{NONE}@}]
984     [@t{INCLUDEMRSETS=}@{@t{YES} @math{|} @t{NO}@}]
985     [@t{MEANSVARIANCE=}@{@t{ALLCATS} @math{|} @t{TESTEDCATS}@}]
986     [@t{CATEGORIES=}@{@t{ALLVISIBLE} @math{|} @t{SUBTOTALS}@}]
987     [@t{MERGE=}@{@t{NO} @math{|} @t{YES}@}]
988     [@t{STYLE=}@{@t{APA} @math{|} @t{SIMPLE}@}]
989     [@t{SHOWSIG=}@{@t{NO} @math{|} @t{YES}@}]
990 @end ignore
991 @end display
992
993 The @code{CTABLES} (aka ``custom tables'') command produces
994 multi-dimensional tables from categorical and scale data.  It offers
995 many options for data summarization and formatting.
996
997 This section's examples use data from the 2008 (USA) National Survey
998 of Drinking and Driving Attitudes and Behaviors, a public domain data
999 set from the (USA) National Highway Traffic Administration and
1000 available at @url{https://data.transportation.gov}.  @pspp{} includes
1001 this data set, with a slightly modified dictionary, as
1002 @file{examples/nhtsa.sav}.
1003
1004 @node CTABLES Basics
1005 @subsection Basics
1006
1007 The only required subcommand is @code{TABLE}, which specifies the
1008 variables to include along each axis:
1009 @display
1010 @t{/TABLE} @i{rows} [@t{BY} @i{columns} [@t{BY} @i{layers}]]
1011 @end display
1012 @noindent
1013 In @code{TABLE}, each of @var{rows}, @var{columns}, and @var{layers}
1014 is either empty or an axis expression that specifies one or more
1015 variables.  At least one must specify an axis expression.
1016
1017 @menu
1018 * CTABLES Categorical Variable Basics::
1019 * CTABLES Scalar Variable Basics::
1020 * CTABLES Overriding Measurement Level::
1021 @end menu
1022
1023 @node CTABLES Categorical Variable Basics
1024 @subsubsection Categorical Variables
1025
1026 An axis expression that names a categorical variable divides the data
1027 into cells according to the values of that variable.  When all the
1028 variables named on @code{TABLE} are categorical, by default each cell
1029 displays the number of cases that it contains, so specifying a single
1030 variable yields a frequency table:
1031
1032 @example
1033 CTABLES /TABLE=AgeGroup.
1034 @end example
1035 @psppoutput {ctables1}
1036
1037 @noindent
1038 Specifying a row and a column categorical variable yields a
1039 crosstabulation:
1040
1041 @example
1042 CTABLES /TABLE=AgeGroup BY qns3a.
1043 @end example
1044 @psppoutput {ctables2}
1045
1046 @noindent
1047 The @samp{>} ``nesting'' operator nests multiple variables on a single
1048 axis, e.g.:
1049
1050 @example
1051 CTABLES /TABLE qn105ba BY AgeGroup > qns3a.
1052 @end example
1053 @psppoutput {ctables3}
1054
1055 @noindent
1056 The @samp{+} ``stacking'' operator allows a single output table to
1057 include multiple data analyses.  With @samp{+}, @code{CTABLES} divides
1058 the output table into multiple @dfn{sections}, each of which includes
1059 an analysis of the full data set.  For example, the following command
1060 separately tabulates age group and driving frequency by gender:
1061
1062 @example
1063 CTABLES /TABLE AgeGroup + qn1 BY qns3a.
1064 @end example
1065 @psppoutput {ctables4}
1066
1067 @noindent
1068 When @samp{+} and @samp{>} are used together, @samp{>} binds more
1069 tightly.  Use parentheses to override operator precedence.  Thus:
1070
1071 @example
1072 CTABLES /TABLE qn26 + qn27 > qns3a.
1073 CTABLES /TABLE (qn26 + qn27) > qns3a.
1074 @end example
1075 @psppoutput {ctables5}
1076
1077 @node CTABLES Scalar Variable Basics
1078 @subsubsection Scalar Variables
1079
1080 For a categorical variable, @code{CTABLES} divides the table into a
1081 cell per category.  For a scalar variable, @code{CTABLES} instead
1082 calculates a summary measure, by default the mean, of the values that
1083 fall into a cell.  For example, if the only variable specified is a
1084 scalar variable, then the output is a single cell that holds the mean
1085 of all of the data:
1086
1087 @example
1088 CTABLES /TABLE qnd1.
1089 @end example
1090 @psppoutput {ctables6}
1091
1092 A scalar variable may nest with categorical variables.  The following
1093 example shows the mean age of survey respondents across gender and
1094 language groups:
1095
1096 @example
1097 CTABLES /TABLE qns3a > qnd1 BY region.
1098 @end example
1099 @psppoutput {ctables7}
1100
1101 The order of nesting of scalar and categorical variables affects table
1102 labeling, but it does not affect the data displayed in the table.  The
1103 following example shows how the output changes when the nesting order
1104 of the scalar and categorical variable are interchanged:
1105
1106 @example
1107 CTABLES /TABLE qnd1 > qns3a BY region.
1108 @end example
1109 @psppoutput {ctables8}
1110
1111 Only a single scalar variable may appear in each section; that is, a
1112 scalar variable may not nest inside a scalar variable directly or
1113 indirectly.  Scalar variables may only appear on one axis within
1114 @code{TABLE}.
1115
1116 @node CTABLES Overriding Measurement Level
1117 @subsubsection Overriding Measurement Level
1118
1119 By default, @code{CTABLES} uses a variable's measurement level to
1120 decide whether to treat it as categorical or scalar.  Variables
1121 assigned the nominal or ordinal measurement level are treated as
1122 categorical, and scalar variables are treated as scalar.
1123
1124 Use the @code{VARIABLE LEVEL} command to change a variable's
1125 measurement level (@pxref{VARIABLE LEVEL}).  To treat a variable as
1126 categorical or scalar only for one use on @code{CTABLES}, add
1127 @samp{[C]} or @samp{[S]}, respectively, after the variable name.  The
1128 following example shows how to analyze the scalar variable @code{qn20}
1129 as categorical:
1130
1131 @example
1132 CTABLES /TABLE qn20 [C] BY qns3a.
1133 @end example
1134 @psppoutput {ctables9}
1135
1136 @ignore
1137 @node CTABLES Multiple Response Sets
1138 @subsubheading Multiple Response Sets
1139
1140 The @code{CTABLES} command does not yet support multiple response
1141 sets.
1142 @end ignore
1143
1144 @node CTABLES Data Summarization
1145 @subsection Data Summarization
1146
1147 The @code{CTABLES} command allows the user to control how the data are
1148 summarized with summary specifications, which are enclosed in square
1149 brackets following a variable name on the @code{TABLE} subcommand.
1150 When all the variables are categorical, summary specifications can be
1151 given for the innermost nested variables on any one axis.  When a
1152 scalar variable is present, only the scalar variable may have summary
1153 specifications.  The following example includes a summary
1154 specification for column and row percentages for categorical
1155 variables, and mean and median for a scalar variable:
1156
1157 @example
1158 CTABLES
1159     /TABLE=qnd1 [MEAN, MEDIAN] BY qns3a
1160     /TABLE=AgeGroup [COLPCT, ROWPCT] BY qns3a.
1161 @end example
1162 @psppoutput {ctables10}
1163
1164 A summary specification may override the default label and format by
1165 appending a string or format specification or both (in that order) to
1166 the summary function name.  For example:
1167
1168 @example
1169 CTABLES /TABLE=AgeGroup [COLPCT 'Gender %' PCT5.0,
1170                          ROWPCT 'Age Group %' PCT5.0]
1171                BY qns3a.
1172 @end example
1173 @psppoutput {ctables11}
1174
1175 Parentheses provide a shorthand to apply summary specifications to
1176 multiple variables.  For example, both of these commands:
1177
1178 @example
1179 CTABLES /TABLE=AgeGroup[COLPCT] + qns1[COLPCT] BY qns3a.
1180 CTABLES /TABLE=(AgeGroup + qns1)[COLPCT] BY qns3a.
1181 @end example
1182
1183 @noindent
1184 produce the same output shown below:
1185
1186 @psppoutput {ctables12}
1187
1188 The following sections list the available summary functions.
1189
1190 @menu
1191 * CTABLES Summary Functions for Individual Cells::
1192 * CTABLES Summary Functions for Groups of Cells::
1193 * CTABLES Summary Functions for Adjusted Weights::
1194 * CTABLES Unweighted Summary Functions::
1195 @end menu
1196
1197 @node CTABLES Summary Functions for Individual Cells
1198 @subsubsection Summary Functions for Individual Cells
1199
1200 This section lists the summary functions that consider only an
1201 individual cell in @code{CTABLES}.  Only one such summary function,
1202 @code{COUNT}, may be applied to both categorical and scale variables:
1203
1204 @table @asis
1205 @item @code{COUNT} (``Count'')
1206 The sum of weights in a cell.
1207
1208 If @code{CATEGORIES} for one or more of the variables in a table
1209 include missing values (@pxref{CTABLES Per-Variable Category
1210 Options}), then some or all of the categories for a cell might be
1211 missing values.  @code{COUNT} counts data included in a cell
1212 regardless of whether its categories are missing.
1213 @end table
1214
1215 The following summary functions apply only to scale variables or
1216 totals and subtotals for categorical variables.  Be cautious about
1217 interpreting the summary value in the latter case, because it is not
1218 necessarily meaningful; however, the mean of a Likert scale, etc.@:
1219 may have a straightforward interpreation.
1220
1221 @table @asis
1222 @item @code{MAXIMUM} (``Maximum'')
1223 The largest value.
1224
1225 @item @code{MEAN} (``Mean'')
1226 The mean.
1227
1228 @item @code{MEDIAN} (``Median'')
1229 The median value.
1230
1231 @item @code{MINIMUM} (``Minimum'')
1232 The smallest value.
1233
1234 @item @code{MISSING} (``Missing'')
1235 Sum of weights of user- and system-missing values.
1236
1237 @item @code{MODE} (``Mode'')
1238 The highest-frequency value.  Ties are broken by taking the smallest mode.
1239
1240 @item @code{PTILE} @i{n} (``Percentile @i{n}'')
1241 The @var{n}th percentile, where @math{0 @leq{} @var{n} @leq{} 100}.
1242
1243 @item @code{RANGE} (``Range'')
1244 The maximum minus the minimum.
1245
1246 @item @code{SEMEAN} (``Std Error of Mean'')
1247 The standard error of the mean.
1248
1249 @item @code{STDDEV} (``Std Deviation'')
1250 The standard deviation.
1251
1252 @item @code{SUM} (``Sum'')
1253 The sum.
1254
1255 @item @code{TOTALN} (``Total N'')
1256 The sum of weights in a cell.
1257
1258 For scale data, @code{COUNT} and @code{TOTALN} are the same.
1259
1260 For categorical data, @code{TOTALN} counts missing values in excluded
1261 categories, that is, user-missing values not in an explicit category
1262 list on @code{CATEGORIES} (@pxref{CTABLES Per-Variable Category
1263 Options}), or user-missing values excluded because
1264 @code{MISSING=EXCLUDE} is in effect on @code{CATEGORIES}, or
1265 system-missing values.  @code{COUNT} does not count these.
1266
1267 @item @code{VALIDN} (``Valid N'')
1268 The sum of valid count weights in included categories.
1269
1270 @code{VALIDN} does not count missing values regardless of whether they
1271 are in included categories via @code{CATEGORIES}.  @code{VALIDN} does
1272 not count valid values that are in excluded categories.
1273
1274 @item @code{VARIANCE} (``Variance'')
1275 The variance.
1276 @end table
1277
1278 @node CTABLES Summary Functions for Groups of Cells
1279 @subsubsection Summary Functions for Groups of Cells
1280
1281 These summary functions summarize over multiple cells within an area
1282 of the output chosen by the user and specified as part of the function
1283 name.  The following basic @var{area}s are supported, in decreasing
1284 order of size:
1285
1286 @table @code
1287 @item TABLE
1288 A @dfn{section}.  Stacked variables divide sections of the output from
1289 each other.  sections may span multiple layers.
1290
1291 @item LAYER
1292 A section within a single layer.
1293
1294 @item SUBTABLE
1295 A @dfn{subtable}, whose contents are the cells that pair an innermost
1296 row variable and an innermost column variable within a single layer.
1297 @end table
1298
1299 The following shows how the output for the table expression @code{qn61
1300 > qn57 BY qnd7a > qn86 + qn64b BY qns3a}@footnote{This is not
1301 necessarily a meaningful table, so for clarity variable labels are
1302 omitted.} is divided up into @code{TABLE}, @code{LAYER}, and
1303 @code{SUBTABLE} areas.  Each unique value for Table ID is one section,
1304 and similarly for Layer ID and Subtable ID.  Thus, this output has two
1305 @code{TABLE} areas (one for @code{qnd7a} and one for @code{qn64b}),
1306 four @code{LAYER} areas (for those two variables, per layer), and 12
1307 @code{SUBTABLE} areas.
1308 @psppoutput {ctables22}
1309
1310 @code{CTABLES} also supports the following @var{area}s that further
1311 divide a subtable or a layer within a section:
1312
1313 @table @code
1314 @item LAYERROW
1315 @itemx LAYERCOL
1316 A row or column, respectively, in one layer of a section.
1317
1318 @item ROW
1319 @itemx COL
1320 A row or column, respectively, in a subtable.
1321 @end table
1322
1323 The following summary functions for groups of cells are available for
1324 each @var{area} described above, for both categorical and scale
1325 variables:
1326
1327 @table @asis
1328 @item @code{@i{area}PCT} or @code{@i{area}PCT.COUNT} (``@i{Area} %'')
1329 A percentage of total counts within @var{area}.
1330
1331 @item @code{@i{area}PCT.VALIDN} (``@i{Area} Valid N %'')
1332 A percentage of total counts for valid values within @var{area}.
1333
1334 @item @code{@i{area}PCT.TOTALN} (``@i{Area} Total N %'')
1335 A percentage of total counts for all values within @var{area}.
1336 @end table
1337
1338 Scale variables and totals and subtotals for categorical variables may
1339 use the following additional group cell summary function:
1340
1341 @table @asis
1342 @item @code{@i{area}PCT.SUM} (``@i{Area} Sum %'')
1343 Percentage of the sum of the values within @var{area}.
1344 @end table
1345
1346 @node CTABLES Summary Functions for Adjusted Weights
1347 @subsubsection Summary Functions for Adjusted Weights
1348
1349 If the @code{WEIGHT} subcommand specified an adjustment weight
1350 variable, then the following summary functions use its value instead
1351 of the dictionary weight variable.  Otherwise, they are equivalent to
1352 the summary function without the @samp{E}-prefix:
1353
1354 @itemize @bullet
1355 @item
1356 @code{ECOUNT} (``Adjusted Count'')
1357
1358 @item
1359 @code{ETOTALN} (``Adjusted Total N'')
1360
1361 @item
1362 @code{EVALIDN} (``Adjusted Valid N'')
1363 @end itemize
1364
1365 @node CTABLES Unweighted Summary Functions
1366 @subsubsection Unweighted Summary Functions
1367
1368 The following summary functions with a @samp{U}-prefix are equivalent
1369 to the same ones without the prefix, except that they use unweighted
1370 counts:
1371
1372 @itemize @bullet
1373 @item
1374 @code{UCOUNT} (``Unweighted Count'')
1375
1376 @item
1377 @code{U@i{area}PCT} or @code{U@i{area}PCT.COUNT} (``Unweighted @i{Area} %'')
1378
1379 @item
1380 @code{U@i{area}PCT.VALIDN} (``Unweighted @i{Area} Valid N %'')
1381
1382 @item
1383 @code{U@i{area}PCT.TOTALN} (``Unweighted @i{Area} Total N %'')
1384
1385 @item
1386 @code{UMEAN} (``Unweighted Mean'')
1387
1388 @item
1389 @code{UMEDIAN} (``Unweighted Median'')
1390
1391 @item
1392 @code{UMISSING} (``Unweighted Missing'')
1393
1394 @item
1395 @code{UMODE} (``Unweight Mode'')
1396
1397 @item
1398 @code{U@i{area}PCT.SUM} (``Unweighted @i{Area} Sum %'')
1399
1400 @item
1401 @code{UPTILE} @i{n} (``Unweighted Percentile @i{n}'') 
1402
1403 @item
1404 @code{USEMEAN} (``Unweighted Std Error of Mean'')
1405
1406 @item
1407 @code{USTDDEV} (``Unweighted Std Deviation'')
1408
1409 @item
1410 @code{USUM} (``Unweighted Sum'')
1411
1412 @item
1413 @code{UTOTALN} (``Unweighted Total N'')
1414
1415 @item
1416 @code{UVALIDN} (``Unweighted Valid N'')
1417
1418 @item
1419 @code{UVARIANCE} (``Unweighted Variance'')
1420 @end itemize
1421
1422 @node CTABLES Statistics Positions and Labels
1423 @subsection Statistics Positions and Labels
1424
1425 @display
1426 @t{/SLABELS}
1427     [@t{POSITION=}@{@t{COLUMN} @math{|} @t{ROW} @math{|} @t{LAYER}@}]
1428     [@t{VISIBLE=}@{@t{YES} @math{|} @t{NO}@}]
1429 @end display
1430
1431 The @code{SLABELS} subcommand controls the position and visibility of
1432 summary statistics for the @code{TABLE} subcommand that it follows.
1433
1434 @code{POSITION} sets the axis on which summary statistics appear.
1435 With @t{POSITION=COLUMN}, which is the default, each summary statistic
1436 appears in a column.  For example:
1437
1438 @example
1439 CTABLES /TABLE=qnd1 [MEAN, MEDIAN] BY qns3a.
1440 @end example
1441 @psppoutput {ctables13}
1442
1443 @noindent
1444 With @t{POSITION=ROW}, each summary statistic appears in a row, as
1445 shown below:
1446
1447 @example
1448 CTABLES /TABLE=qnd1 [MEAN, MEDIAN] BY qns3a /SLABELS POSITION=ROW.
1449 @end example
1450 @psppoutput {ctables14}
1451
1452 @noindent
1453 @t{POSITION=LAYER} is also available to place each summary statistic in
1454 a separate layer.
1455
1456 Labels for summary statistics are shown by default.  Use
1457 @t{VISIBLE=NO} to suppress them.  Because unlabeled data can cause
1458 confusion, it should only be considered if the meaning of the data is
1459 evident, as in a simple case like this:
1460
1461 @example
1462 CTABLES /TABLE=AgeGroup [TABLEPCT] /SLABELS VISIBLE=NO.
1463 @end example
1464 @psppoutput {ctables15}
1465
1466 @node CTABLES Category Label Positions
1467 @subsection Category Label Positions
1468
1469 @display
1470 @t{/CLABELS} @{@t{AUTO} @math{|} @{@t{ROWLABELS}@math{|}@t{COLLABELS}@}@t{=}@{@t{OPPOSITE}@math{|}@t{LAYER}@}@}
1471 @end display
1472
1473 The @code{CLABELS} subcommand controls the position of category labels
1474 for the @code{TABLE} subcommand that it follows.  By default, or if
1475 @t{AUTO} is specified, category labels for a given variable nest
1476 inside the variable's label on the same axis.  For example, the
1477 command below results in age categories nesting within the age group
1478 variable on the rows axis and gender categories within the gender
1479 variable on the columns axis:
1480
1481 @example
1482 CTABLES /TABLE AgeGroup BY qns3a.
1483 @end example
1484 @psppoutput {ctables16}
1485
1486 @t{ROWLABELS=OPPOSITE} or @t{COLLABELS=OPPOSITE} move row or column
1487 variable category labels, respectively, to the opposite axis.  The
1488 setting affects only the innermost variable on the given axis.  For
1489 example:
1490
1491 @example
1492 CTABLES /TABLE AgeGroup BY qns3a /CLABELS ROWLABELS=OPPOSITE.
1493 CTABLES /TABLE AgeGroup BY qns3a /CLABELS COLLABELS=OPPOSITE.
1494 @end example
1495 @psppoutput {ctables17}
1496
1497 @t{ROWLABELS=LAYER} or @t{COLLABELS=LAYER} move the innermost row or
1498 column variable category labels, respectively, to the layer axis.
1499
1500 Only one axis's labels may be moved, whether to the opposite axis or
1501 to the layer axis.
1502
1503 @subsubheading Effect on Summary Statistics
1504
1505 @code{CLABELS} primarily affects the appearance of tables, not the
1506 data displayed in them.  However, @code{CTABLES} can affect the values
1507 displayed for statistics that summarize areas of a table, since it can
1508 change the definitions of these areas.
1509
1510 For example, consider the following syntax and output:
1511
1512 @example
1513 CTABLES /TABLE AgeGroup BY qns3a [ROWPCT, COLPCT].
1514 @end example
1515 @psppoutput {ctables23}
1516
1517 @noindent
1518 Using @code{COLLABELS=OPPOSITE} changes the definitions of rows and
1519 columns, so that column percentages display what were previously row
1520 percentages and the new row percentages become meaningless (because
1521 there is only one cell per row):
1522
1523 @example
1524 CTABLES
1525     /TABLE AgeGroup BY qns3a [ROWPCT, COLPCT]
1526     /CLABELS COLLABELS=OPPOSITE.
1527 @end example
1528 @psppoutput {ctables24}
1529
1530 @node CTABLES Per-Variable Category Options
1531 @subsection Per-Variable Category Options
1532
1533 @display
1534 @t{/CATEGORIES} @t{VARIABLES=}@i{variables}
1535     @{@t{[}@i{value}@t{,} @i{value}@dots{}@t{]}
1536    @math{|} [@t{ORDER=}@{@t{A} @math{|} @t{D}@}]
1537      [@t{KEY=}@{@t{VALUE} @math{|} @t{LABEL} @math{|} @i{summary}@t{(}@i{variable}@t{)}@}]
1538      [@t{MISSING=}@{@t{EXCLUDE} @math{|} @t{INCLUDE}@}]@}
1539     [@t{TOTAL=}@{@t{NO} @math{|} @t{YES}@} [@t{LABEL=}@i{string}] [@t{POSITION=}@{@t{AFTER} @math{|} @t{BEFORE}@}]]
1540     [@t{EMPTY=}@{@t{INCLUDE} @math{|} @t{EXCLUDE}@}]
1541 @end display
1542
1543 The @code{CATEGORIES} subcommand specifies, for one or more
1544 categorical variables, the categories to include and exclude, the sort
1545 order for included categories, and treatment of missing values.  It
1546 also controls the totals and subtotals to display.  It may be
1547 specified any number of times, each time for a different set of
1548 variables.  @code{CATEGORIES} applies to the table produced by the
1549 @code{TABLE} subcommand that it follows.
1550
1551 @code{CATEGORIES} does not apply to scalar variables.
1552
1553 @t{VARIABLES} is required.  List the variables for the subcommand
1554 to affect.
1555
1556 There are two way to specify the Categories to include and their sort
1557 order:
1558
1559 @table @asis
1560 @item Explicit categories.
1561 @anchor{CTABLES Explicit Category List}
1562 To explicitly specify categories to include, list the categories
1563 within square brackets in the desired sort order.  Use spaces or
1564 commas to separate values.  Categories not covered by the list are
1565 excluded from analysis.
1566
1567 Each element of the list takes one of the following forms:
1568
1569 @table @t
1570 @item @i{number}
1571 @itemx '@i{string}'
1572 A numeric or string category value, for variables that have the
1573 corresponding type.
1574
1575 @item '@i{date}'
1576 @itemx '@i{time}'
1577 A date or time category value, for variables that have a date or time
1578 print format.
1579
1580 @item @i{min} THRU @i{max}
1581 @itemx LO THRU @i{max}
1582 @itemx @i{min} THRU HI
1583 A range of category values, where @var{min} and @var{max} each takes
1584 one of the forms above, in increasing order.
1585
1586 @item MISSING
1587 All user-missing values.  (To match individual user-missing values,
1588 specify their category values.)
1589
1590 @item OTHERNM
1591 Any non-missing value not covered by any other element of the list
1592 (regardless of where @t{OTHERNM} is placed in the list).
1593
1594 @item &@i{postcompute}
1595 A computed category name (@pxref{CTABLES Computed Categories}).
1596 @end table
1597
1598 Additional forms, described later, allow for subtotals.
1599 If multiple elements of the list cover a given category, the last one
1600 in the list is considered to be a match.
1601
1602 @item Implicit categories.
1603 Without an explicit list of categories, @pspp{} sorts
1604 categories automatically.
1605
1606 The @code{KEY} setting specifies the sort key.  By default, or with
1607 @code{KEY=VALUE}, categories are sorted by default.  Categories may
1608 also be sorted by value label, with @code{KEY=LABEL}, or by the value
1609 of a summary function, e.g.@: @code{KEY=COUNT}.  For summary
1610 functions, a variable name may be specified in parentheses, e.g.@:
1611 @code{KEY=MAXIUM(qnd1)}, and this is required for functions that apply
1612 only to scalar variables.  The @code{PTILE} function also requires a
1613 percentage argument, e.g.@: @code{KEY=PTILE(qnd1, 90)}.  Only summary
1614 functions used in the table may be used, except that @code{COUNT} is
1615 always allowed.
1616
1617 By default, or with @code{ORDER=A}, categories are sorted in ascending
1618 order.  Specify @code{ORDER=D} to sort in descending order.
1619
1620 User-missing values are excluded by default, or with
1621 @code{MISSING=EXCLUDE}.  Specify @code{MISSING=INCLUDE} to include
1622 user-missing values.  The system-missing value is always excluded.
1623 @end table
1624
1625 @subsubheading Totals and Subtotals
1626
1627 @code{CATEGORIES} also controls display of totals and subtotals.
1628 Totals are not displayed by default, or with @code{TOTAL=NO}.  Specify
1629 @code{TOTAL=YES} to display a total.  By default, the total is labeled
1630 ``Total''; use @code{LABEL="@i{label}"} to override it.
1631
1632 Subtotals are also not displayed by default.  To add one or more
1633 subtotals, use an explicit category list and insert @code{SUBTOTAL} or
1634 @code{HSUBTOTAL} in the position or positions where the subtotal
1635 should appear.  With @code{SUBTOTAL}, the subtotal becomes an extra
1636 row or column or layer; @code{HSUBTOTAL} additionally hides the
1637 categories that make up the subtotal.  Either way, the default label
1638 is ``Subtotal'', use @code{SUBTOTAL="@i{label}"} or
1639 @code{HSUBTOTAL="@i{label}"} to specify a custom label.
1640
1641 By default, or with @code{POSITION=AFTER}, totals come after the last
1642 category and subtotals apply to categories that precede them.  With
1643 @code{POSITION=BEFORE}, totals come before the first category and
1644 subtotals apply to categories that follow them.
1645
1646 Only categorical variables may have totals and subtotals.  Scalar
1647 variables may be ``totaled'' indirectly by enabling totals and
1648 subtotals on a categorical variable within which the scalar variable is
1649 summarized.
1650
1651 @subsubheading Categories Without Values
1652
1653 Some categories might not be included in the data set being analyzed.
1654 For example, our example data set has no cases in the ``15 or
1655 younger'' age group.  By default, or with @code{EMPTY=INCLUDE},
1656 @pspp{} includes these empty categories in output tables.  To exclude
1657 them, specify @code{EMPTY=EXCLUDE}.
1658
1659 For implicit categories, empty categories potentially include all the
1660 values with labels for a given variable; for explicit categories, they
1661 include all the values listed individually and all labeled values
1662 covered by ranges or @code{MISSING} or @code{OTHERNM}.
1663
1664 @node CTABLES Titles
1665 @subsection Titles
1666
1667 @display
1668 @t{/TITLES}
1669     [@t{TITLE=}@i{string}@dots{}]
1670     [@t{CAPTION=}@i{string}@dots{}]
1671     [@t{CORNER=}@i{string}@dots{}]
1672 @end display
1673
1674 The @code{TITLES} subcommand sets the title, caption, and corner text
1675 for the table output for the previous @code{TABLE} subcommand.  The
1676 title appears above the table, the caption below the table, and the
1677 corner text appears in the table's upper left corner.  By default, the
1678 title is ``Custom Tables'' and the caption and corner text are empty.
1679
1680 @node CTABLES Table Formatting
1681 @subsection Table Formatting
1682
1683 @display
1684 @t{/FORMAT}
1685     [@t{MINCOLWIDTH=}@{@t{DEFAULT} @math{|} @i{width}@}]
1686     [@t{MAXCOLWIDTH=}@{@t{DEFAULT} @math{|} @i{width}@}]
1687     [@t{UNITS=}@{@t{POINTS} @math{|} @t{INCHES} @math{|} @t{CM}@}]
1688     [@t{EMPTY=}@{@t{ZERO} @math{|} @t{BLANK} @math{|} @i{string}@}]
1689     [@t{MISSING=}@i{string}]
1690 @end display
1691
1692 The @code{FORMAT} subcommand, which must precede the first
1693 @code{TABLE} subcommand, controls formatting for all the output
1694 tables.  @code{FORMAT} and all of its settings are optional.
1695
1696 Use @code{MINCOLWIDTH} and @code{MAXCOLWIDTH} to control the minimum
1697 or maximum width of columns in output tables.  By default, or with
1698 @code{DEFAULT}, column width varies based on content.  Otherwise,
1699 specify a number for either or both of these settings.  If both are
1700 specified, @code{MAXCOLWIDTH} must be bigger than @code{MINCOLWIDTH}.
1701 The default unit, or with @code{UNITS=POINTS}, is points (1/72 inch),
1702 but specify @code{UNITS=INCHES} to use inches or @code{UNITS=CM} for
1703 centimeters.
1704
1705 By default, or with @code{EMPTY=ZERO}, zero values are displayed in
1706 their usual format.  Use @code{EMPTY=BLANK} to use an empty cell
1707 instead, or @code{EMPTY="@i{string}"} to use the specified string.
1708
1709 By default, missing values are displayed as @samp{.}, the same as in
1710 other tables.  Specify @code{MISSING="@i{string}"} to instead use a
1711 custom string.
1712
1713 @node CTABLES Display of Variable Labels
1714 @subsection Display of Variable Labels
1715
1716 @display
1717 @t{/VLABELS}
1718     @t{VARIABLES=}@i{variables}
1719     @t{DISPLAY}=@{@t{DEFAULT} @math{|} @t{NAME} @math{|} @t{LABEL} @math{|} @t{BOTH} @math{|} @t{NONE}@}
1720 @end display
1721
1722 The @code{VLABELS} subcommand, which must precede the first
1723 @code{TABLE} subcommand, controls display of variable labels in all
1724 the output tables.  @code{VLABELS} is optional.  It may appear
1725 multiple times to adjust settings for different variables.
1726
1727 @code{VARIABLES} and @code{DISPLAY} are required.  The value of
1728 @code{DISPLAY} controls how variable labels are displayed for the
1729 variables listed on @code{VARIABLES}.  The supported values are:
1730
1731 @table @code
1732 @item DEFAULT
1733 Uses the setting from @ref{SET TVARS}.
1734
1735 @item NAME
1736 Show only a variable name.
1737
1738 @item LABEL
1739 Show only a variable label.
1740
1741 @item BOTH
1742 Show variable name and label.
1743
1744 @item NONE
1745 Show nothing.
1746 @end table
1747
1748 @node CTABLES Missing Value Treatment
1749 @subsection Missing Value Treatment
1750
1751 @display
1752 @t{/SMISSING} @{@t{VARIABLE} @math{|} @t{LISTWISE}@}
1753 @end display
1754
1755 The @code{SMISSING} subcommand, which must precede the first
1756 @code{TABLE} subcommand, controls treatment of missing values for
1757 scalar variables in producing all the output tables.  @code{SMISSING}
1758 is optional.
1759
1760 With @code{SMISSING=VARIABLE}, which is the default, missing values
1761 are excluded on a variable-by-variable basis.  With
1762 @code{SMISSING=LISTWISE}, when stacked scalar variables are nested
1763 together with a categorical variable, a missing value for any of the
1764 scalar variables causes the case to be excluded for all of them.
1765
1766 As an example, consider the following dataset, in which @samp{x} is a
1767 categorical variable and @samp{y} and @samp{z} are scale:
1768
1769 @psppoutput{ctables18}
1770
1771 @noindent
1772 With the default missing-value treatment, @samp{x}'s mean is 20, based
1773 on the values 10, 20, and 30, and @samp{y}'s mean is 50, based on 40,
1774 50, and 60:
1775
1776 @example
1777 CTABLES /TABLE (y + z) > x.
1778 @end example
1779 @psppoutput{ctables19}
1780
1781 @noindent
1782 By adding @code{SMISSING=LISTWISE}, only cases where @samp{y} and
1783 @samp{z} are both non-missing are considered, so @samp{x}'s mean
1784 becomes 15, as the average of 10 and 20, and @samp{y}'s mean becomes
1785 55, the average of 50 and 60:
1786
1787 @example
1788 CTABLES /SMISSING LISTWISE /TABLE (y + z) > x.
1789 @end example
1790 @psppoutput{ctables20}
1791
1792 @noindent
1793 Even with @code{SMISSING=LISTWISE}, if @samp{y} and @samp{z} are
1794 separately nested with @samp{x}, instead of using a single @samp{>}
1795 operator, missing values revert to being considered on a
1796 variable-by-variable basis:
1797
1798 @example
1799 CTABLES /SMISSING LISTWISE /TABLE (y > x) + (z > x).
1800 @end example
1801 @psppoutput{ctables21}
1802
1803 @node CTABLES Computed Categories
1804 @subsection Computed Categories
1805
1806 @display
1807 @t{/PCOMPUTE} @t{&}@i{postcompute}@t{=EXPR(}@i{expression}@t{)}
1808 @end display
1809
1810 @dfn{Computed categories}, also called @dfn{postcomputes}, are
1811 categories created using arithmetic on categories obtained from the
1812 data.  The @code{PCOMPUTE} subcommand defines computed categories,
1813 which can then be used in two places: on @code{CATEGORIES} within an
1814 explicit category list (@pxref{CTABLES Explicit Category List}), and on
1815 the @code{PPROPERTIES} subcommand to define further properties for a
1816 given postcompute.
1817
1818 @code{PCOMPUTE} must precede the first @code{TABLE} command.  It is
1819 optional and it may be used any number of times to define multiple
1820 postcomputes.
1821
1822 Each @code{PCOMPUTE} defines one postcompute.  Its syntax consists of
1823 a name to identify the postcompute as a @pspp{} identifier prefixed by
1824 @samp{&}, followed by @samp{=} and a postcompute expression enclosed
1825 in @code{EXPR(@dots{})}.  A postcompute expression consists of:
1826
1827 @table @t
1828 @item [@i{category}]
1829 This form evaluates to the summary statistic for @i{category}, e.g.@:
1830 @code{[1]} evaluates to the value of the summary statistic associated
1831 with category 1.  The @i{category} may be a number, a quoted string,
1832 or a quoted time or date value, and all of the categories for a given
1833 postcompute must have the same form.
1834
1835 @item [@i{min} THRU @i{max}]
1836 @itemx [LO THRU @i{max}]
1837 @itemx [@i{min} THRU HI]
1838 @itemx MISSING
1839 @itemx OTHERNM
1840 These forms evaluate to the summary statistics for categories matching
1841 the given syntax, as described in previous sections (@pxref{CTABLES
1842 Explicit Category List}).  If more than one category matches, their
1843 values are summed.
1844
1845 @item SUBTOTAL
1846 The summary statistic for the subtotal category.  This form is allowed
1847 only for variables with exactly one subtotal.
1848
1849 @item SUBTOTAL[@i{index}]
1850 The summary statistic for subtotal category @i{index}, where 1 is the
1851 first subtotal, 2 is the second, and so on.  This form may be used for
1852 any number of subtotals.
1853
1854 @item TOTAL
1855 The summary statistic for the total.
1856
1857 @item @i{a} + @i{b}
1858 @itemx @i{a} - @i{b}
1859 @itemx @i{a} * @i{b}
1860 @itemx @i{a} / @i{b}
1861 @itemx @i{a} ** @i{b}
1862 These forms perform arithmetic on the values of postcompute
1863 expressions @i{a} and @i{b}.  The usual operator precedence rules
1864 apply.
1865
1866 @item @i{number}
1867 Numeric constants may be used in postcompute expressions.
1868
1869 @item (@i{a})
1870 Parentheses override operator precedence.
1871 @end table
1872
1873 A postcompute is not associated with any particular variable.
1874 Instead, it may be referenced within @code{CATEGORIES} for any
1875 suitable variable (e.g.@: only a string variable is suitable for a
1876 postcompute expression that refers to a string category, only a
1877 variable with subtotals for an expression that refers to subtotals,
1878 @dots{}).
1879
1880 Normally a named postcompute is defined only once, but if a later
1881 @code{PCOMPUTE} redefines a postcompute with the same name as an
1882 earlier one, the later one take precedence.
1883
1884 @node CTABLES Computed Category Properties
1885 @subsection Computed Category Properties
1886
1887 @display
1888 @t{/PPROPERTIES} @t{&}@i{postcompute}@dots{}
1889     [@t{LABEL=}@i{string}]
1890     [@t{FORMAT=}[@i{summary} @i{format}]@dots{}]
1891     [@t{HIDESOURCECATS=}@{@t{NO} @math{|} @t{YES}@}
1892 @end display
1893
1894 The @code{PPROPERTIES} subcommand, which must appear before
1895 @code{TABLE}, sets properties for one or more postcomputes defined on
1896 prior @code{PCOMPUTE} subcommands.  The subcommand syntax begins with
1897 the list of postcomputes, each prefixed with @samp{&} as specified on
1898 @code{PCOMPUTE}.
1899
1900 All of the settings on @code{PPROPERTIES} are optional.  Use
1901 @code{LABEL} to set the label shown for the postcomputes in table
1902 output.  The default label for a postcompute is the expression used to
1903 define it.
1904
1905 The @code{FORMAT} setting sets summary statistics and display formats
1906 for the postcomputes.
1907
1908 By default, or with @code{HIDESOURCECATS=NO}, categories referred to
1909 by computed categories are displayed like other categories.  Use
1910 @code{HIDESOURCECATS=YES} to hide them.
1911
1912 @node CTABLES Base Weight
1913 @subsection Base Weight
1914
1915 @display
1916 @t{/WEIGHT VARIABLE=}@i{variable}
1917 @end display
1918
1919 The @code{WEIGHT} subcommand is optional and must appear before
1920 @code{TABLE}.  If it appears, it must name a numeric variable, known
1921 as the @dfn{effective base weight} or @dfn{adjustment weight}.  The
1922 effective base weight variable is used for the @code{ECOUNT},
1923 @code{ETOTALN}, and @code{EVALIDN} summary functions.
1924
1925 Cases with zero, missing, or negative effective base weight are
1926 excluded from all analysis.
1927
1928 Weights obtained from the @pspp{} dictionary are rounded to the
1929 nearest integer.  Effective base weights are not rounded.
1930
1931 @node CTABLES Hiding Small Counts
1932 @subsection Hiding Small Counts
1933
1934 @display
1935 @t{/HIDESMALLCOUNTS COUNT=@i{count}}
1936 @end display
1937
1938 The @code{HIDESMALLCOUNTS} subcommand is optional.  If it specified,
1939 then count values in output tables less than the value of @i{count}
1940 are shown as @code{<@i{count}} instead of their true values.  The
1941 value of @i{count} must be an integer and must be at least 2.  Case
1942 weights are considered for deciding whether to hide a count.
1943
1944 @node FACTOR
1945 @section FACTOR
1946
1947 @vindex FACTOR
1948 @cindex factor analysis
1949 @cindex principal components analysis
1950 @cindex principal axis factoring
1951 @cindex data reduction
1952
1953 @display
1954 FACTOR  @{
1955          VARIABLES=@var{var_list},
1956          MATRIX IN (@{CORR,COV@}=@{*,@var{file_spec}@})
1957         @}
1958
1959         [ /METHOD = @{CORRELATION, COVARIANCE@} ]
1960
1961         [ /ANALYSIS=@var{var_list} ]
1962
1963         [ /EXTRACTION=@{PC, PAF@}]
1964
1965         [ /ROTATION=@{VARIMAX, EQUAMAX, QUARTIMAX, PROMAX[(@var{k})], NOROTATE@}]
1966
1967         [ /PRINT=[INITIAL] [EXTRACTION] [ROTATION] [UNIVARIATE] [CORRELATION] [COVARIANCE] [DET] [KMO] [AIC] [SIG] [ALL] [DEFAULT] ]
1968
1969         [ /PLOT=[EIGEN] ]
1970
1971         [ /FORMAT=[SORT] [BLANK(@var{n})] [DEFAULT] ]
1972
1973         [ /CRITERIA=[FACTORS(@var{n})] [MINEIGEN(@var{l})] [ITERATE(@var{m})] [ECONVERGE (@var{delta})] [DEFAULT] ]
1974
1975         [ /MISSING=[@{LISTWISE, PAIRWISE@}] [@{INCLUDE, EXCLUDE@}] ]
1976 @end display
1977
1978 The @cmd{FACTOR} command performs Factor Analysis or Principal Axis Factoring on a dataset.  It may be used to find
1979 common factors in the data or for data reduction purposes.
1980
1981 The @subcmd{VARIABLES} subcommand is required (unless the @subcmd{MATRIX IN}
1982 subcommand is used).
1983 It lists the variables which are to partake in the analysis.  (The @subcmd{ANALYSIS}
1984 subcommand may optionally further limit the variables that
1985 participate; it is useful primarily in conjunction with @subcmd{MATRIX IN}.)
1986
1987 If @subcmd{MATRIX IN} instead of @subcmd{VARIABLES} is specified, then the analysis
1988 is performed on a pre-prepared correlation or covariance matrix file instead of on
1989 individual data cases.  Typically the matrix file will have been generated by
1990 @cmd{MATRIX DATA} (@pxref{MATRIX DATA}) or provided by a third party.
1991 If specified, @subcmd{MATRIX IN} must be followed by @samp{COV} or @samp{CORR},
1992 then by @samp{=} and @var{file_spec} all in parentheses.
1993 @var{file_spec} may either be an asterisk, which indicates the currently loaded
1994 dataset, or it may be a file name to be loaded. @xref{MATRIX DATA}, for the expected
1995 format of the file.
1996
1997 The @subcmd{/EXTRACTION} subcommand is used to specify the way in which factors
1998 (components) are extracted from the data.
1999 If @subcmd{PC} is specified, then Principal Components Analysis is used.
2000 If @subcmd{PAF} is specified, then Principal Axis Factoring is
2001 used. By default Principal Components Analysis is used.
2002
2003 The @subcmd{/ROTATION} subcommand is used to specify the method by which the
2004 extracted solution is rotated.  Three orthogonal rotation methods are available:
2005 @subcmd{VARIMAX} (which is the default), @subcmd{EQUAMAX}, and @subcmd{QUARTIMAX}.
2006 There is one oblique rotation method, @i{viz}: @subcmd{PROMAX}.
2007 Optionally you may enter the power of the promax rotation @var{k}, which must be enclosed in parentheses.
2008 The default value of @var{k} is 5.
2009 If you don't want any rotation to be performed, the word @subcmd{NOROTATE}
2010 prevents the command from performing any rotation on the data.
2011
2012 The @subcmd{/METHOD} subcommand should be used to determine whether the
2013 covariance matrix or the correlation matrix of the data is
2014 to be analysed.  By default, the correlation matrix is analysed.
2015
2016 The @subcmd{/PRINT} subcommand may be used to select which features of the analysis are reported:
2017
2018 @itemize
2019 @item @subcmd{UNIVARIATE}
2020       A table of mean values, standard deviations and total weights are printed.
2021 @item @subcmd{INITIAL}
2022       Initial communalities and eigenvalues are printed.
2023 @item @subcmd{EXTRACTION}
2024       Extracted communalities and eigenvalues are printed.
2025 @item @subcmd{ROTATION}
2026       Rotated communalities and eigenvalues are printed.
2027 @item @subcmd{CORRELATION}
2028       The correlation matrix is printed.
2029 @item @subcmd{COVARIANCE}
2030       The covariance matrix is printed.
2031 @item @subcmd{DET}
2032       The determinant of the correlation or covariance matrix is printed.
2033 @item @subcmd{AIC}
2034       The anti-image covariance and anti-image correlation matrices are printed.
2035 @item @subcmd{KMO}
2036       The Kaiser-Meyer-Olkin measure of sampling adequacy and the Bartlett test of sphericity is printed.
2037 @item @subcmd{SIG}
2038       The significance of the elements of correlation matrix is printed.
2039 @item @subcmd{ALL}
2040       All of the above are printed.
2041 @item @subcmd{DEFAULT}
2042       Identical to @subcmd{INITIAL} and @subcmd{EXTRACTION}.
2043 @end itemize
2044
2045 If @subcmd{/PLOT=EIGEN} is given, then a ``Scree'' plot of the eigenvalues is
2046 printed.  This can be useful for visualizing the factors and deciding
2047 which factors (components) should be retained.
2048
2049 The @subcmd{/FORMAT} subcommand determined how data are to be
2050 displayed in loading matrices.  If @subcmd{SORT} is specified, then
2051 the variables are sorted in descending order of significance.  If
2052 @subcmd{BLANK(@var{n})} is specified, then coefficients whose absolute
2053 value is less than @var{n} are not printed.  If the keyword
2054 @subcmd{DEFAULT} is specified, or if no @subcmd{/FORMAT} subcommand is
2055 specified, then no sorting is performed, and all coefficients are printed.
2056
2057 You can use the @subcmd{/CRITERIA} subcommand to specify how the number of
2058 extracted factors (components) are chosen.  If @subcmd{FACTORS(@var{n})} is
2059 specified, where @var{n} is an integer, then @var{n} factors are
2060 extracted.  Otherwise, the @subcmd{MINEIGEN} setting is used.
2061 @subcmd{MINEIGEN(@var{l})} requests that all factors whose eigenvalues
2062 are greater than or equal to @var{l} are extracted. The default value
2063 of @var{l} is 1. The @subcmd{ECONVERGE} setting has effect only when
2064 using iterative algorithms for factor extraction (such as Principal Axis
2065 Factoring).  @subcmd{ECONVERGE(@var{delta})} specifies that
2066 iteration should cease when the maximum absolute value of the
2067 communality estimate between one iteration and the previous is less
2068 than @var{delta}. The default value of @var{delta} is 0.001.
2069
2070 The @subcmd{ITERATE(@var{m})} may appear any number of times and is
2071 used for two different purposes. It is used to set the maximum number
2072 of iterations (@var{m}) for convergence and also to set the maximum
2073 number of iterations for rotation.
2074 Whether it affects convergence or rotation depends upon which
2075 subcommand follows the @subcmd{ITERATE} subcommand.
2076 If @subcmd{EXTRACTION} follows, it affects convergence.
2077 If @subcmd{ROTATION} follows, it affects rotation.
2078 If neither @subcmd{ROTATION} nor @subcmd{EXTRACTION} follow a
2079 @subcmd{ITERATE} subcommand, then the entire subcommand is ignored.
2080 The default value of @var{m} is 25.
2081
2082 The @cmd{MISSING} subcommand determines the handling of missing
2083 variables.  If @subcmd{INCLUDE} is set, then user-missing values are
2084 included in the calculations, but system-missing values are not.
2085 If @subcmd{EXCLUDE} is set, which is the default, user-missing
2086 values are excluded as well as system-missing values.  This is the
2087 default. If @subcmd{LISTWISE} is set, then the entire case is excluded
2088 from analysis whenever any variable  specified in the @cmd{VARIABLES}
2089 subcommand contains a missing value.
2090
2091 If @subcmd{PAIRWISE} is set, then a case is considered missing only if
2092 either of the values  for the particular coefficient are missing.
2093 The default is @subcmd{LISTWISE}.
2094
2095 @node GLM
2096 @section GLM
2097
2098 @vindex GLM
2099 @cindex univariate analysis of variance
2100 @cindex fixed effects
2101 @cindex factorial anova
2102 @cindex analysis of variance
2103 @cindex ANOVA
2104
2105
2106 @display
2107 GLM @var{dependent_vars} BY @var{fixed_factors}
2108      [/METHOD = SSTYPE(@var{type})]
2109      [/DESIGN = @var{interaction_0} [@var{interaction_1} [... @var{interaction_n}]]]
2110      [/INTERCEPT = @{INCLUDE|EXCLUDE@}]
2111      [/MISSING = @{INCLUDE|EXCLUDE@}]
2112 @end display
2113
2114 The @cmd{GLM} procedure can be used for fixed effects factorial Anova.
2115
2116 The @var{dependent_vars} are the variables to be analysed.
2117 You may analyse several variables in the same command in which case they should all
2118 appear before the @code{BY} keyword.
2119
2120 The @var{fixed_factors} list must be one or more categorical variables.  Normally it
2121 does not make sense to enter a scalar variable in the @var{fixed_factors} and doing
2122 so may cause @pspp{} to do a lot of unnecessary processing.
2123
2124 The @subcmd{METHOD} subcommand is used to change the method for producing the sums of
2125 squares.  Available values of @var{type} are 1, 2 and 3.  The default is type 3.
2126
2127 You may specify a custom design using the @subcmd{DESIGN} subcommand.
2128 The design comprises a list of interactions where each interaction is a
2129 list of variables separated by a @samp{*}.  For example the command
2130 @display
2131 GLM subject BY sex age_group race
2132     /DESIGN = age_group sex group age_group*sex age_group*race
2133 @end display
2134 @noindent specifies the model @math{subject = age_group + sex + race + age_group*sex + age_group*race}.
2135 If no @subcmd{DESIGN} subcommand is specified, then the default is all possible combinations
2136 of the fixed factors.  That is to say
2137 @display
2138 GLM subject BY sex age_group race
2139 @end display
2140 implies the model
2141 @math{subject = age_group + sex + race + age_group*sex + age_group*race + sex*race + age_group*sex*race}.
2142
2143
2144 The @subcmd{MISSING} subcommand determines the handling of missing
2145 variables.
2146 If @subcmd{INCLUDE} is set then, for the purposes of GLM analysis,
2147 only system-missing values are considered
2148 to be missing; user-missing values are not regarded as missing.
2149 If @subcmd{EXCLUDE} is set, which is the default, then user-missing
2150 values are considered to be missing as well as system-missing values.
2151 A case for which any dependent variable or any factor
2152 variable has a missing value is excluded from the analysis.
2153
2154 @node LOGISTIC REGRESSION
2155 @section LOGISTIC REGRESSION
2156
2157 @vindex LOGISTIC REGRESSION
2158 @cindex logistic regression
2159 @cindex bivariate logistic regression
2160
2161 @display
2162 LOGISTIC REGRESSION [VARIABLES =] @var{dependent_var} WITH @var{predictors}
2163
2164      [/CATEGORICAL = @var{categorical_predictors}]
2165
2166      [@{/NOCONST | /ORIGIN | /NOORIGIN @}]
2167
2168      [/PRINT = [SUMMARY] [DEFAULT] [CI(@var{confidence})] [ALL]]
2169
2170      [/CRITERIA = [BCON(@var{min_delta})] [ITERATE(@var{max_interations})]
2171                   [LCON(@var{min_likelihood_delta})] [EPS(@var{min_epsilon})]
2172                   [CUT(@var{cut_point})]]
2173
2174      [/MISSING = @{INCLUDE|EXCLUDE@}]
2175 @end display
2176
2177 Bivariate Logistic Regression is used when you want to explain a dichotomous dependent
2178 variable in terms of one or more predictor variables.
2179
2180 The minimum command is
2181 @example
2182 LOGISTIC REGRESSION @var{y} WITH @var{x1} @var{x2} @dots{} @var{xn}.
2183 @end example
2184 Here, @var{y} is the dependent variable, which must be dichotomous and @var{x1} @dots{} @var{xn}
2185 are the predictor variables whose coefficients the procedure estimates.
2186
2187 By default, a constant term is included in the model.
2188 Hence, the full model is
2189 @math{
2190 {\bf y}
2191 = b_0 + b_1 {\bf x_1}
2192 + b_2 {\bf x_2}
2193 + \dots
2194 + b_n {\bf x_n}
2195 }
2196
2197 Predictor variables which are categorical in nature should be listed on the @subcmd{/CATEGORICAL} subcommand.
2198 Simple variables as well as interactions between variables may be listed here.
2199
2200 If you want a model without the constant term @math{b_0}, use the keyword @subcmd{/ORIGIN}.
2201 @subcmd{/NOCONST} is a synonym for @subcmd{/ORIGIN}.
2202
2203 An iterative Newton-Raphson procedure is used to fit the model.
2204 The @subcmd{/CRITERIA} subcommand is used to specify the stopping criteria of the procedure,
2205 and other parameters.
2206 The value of @var{cut_point} is used in the classification table.  It is the
2207 threshold above which predicted values are considered to be 1.  Values
2208 of @var{cut_point} must lie in the range [0,1].
2209 During iterations, if any one of the stopping criteria are satisfied, the procedure is
2210 considered complete.
2211 The stopping criteria are:
2212 @itemize
2213 @item The number of iterations exceeds @var{max_iterations}.
2214       The default value of @var{max_iterations} is 20.
2215 @item The change in the all coefficient estimates are less than @var{min_delta}.
2216 The default value of @var{min_delta} is 0.001.
2217 @item The magnitude of change in the likelihood estimate is less than @var{min_likelihood_delta}.
2218 The default value of @var{min_delta} is zero.
2219 This means that this criterion is disabled.
2220 @item The differential of the estimated probability for all cases is less than @var{min_epsilon}.
2221 In other words, the probabilities are close to zero or one.
2222 The default value of @var{min_epsilon} is 0.00000001.
2223 @end itemize
2224
2225
2226 The @subcmd{PRINT} subcommand controls the display of optional statistics.
2227 Currently there is one such option, @subcmd{CI}, which indicates that the
2228 confidence interval of the odds ratio should be displayed as well as its value.
2229 @subcmd{CI} should be followed by an integer in parentheses, to indicate the
2230 confidence level of the desired confidence interval.
2231
2232 The @subcmd{MISSING} subcommand determines the handling of missing
2233 variables.
2234 If @subcmd{INCLUDE} is set, then user-missing values are included in the
2235 calculations, but system-missing values are not.
2236 If @subcmd{EXCLUDE} is set, which is the default, user-missing
2237 values are excluded as well as system-missing values.
2238 This is the default.
2239
2240 @node MEANS
2241 @section MEANS
2242
2243 @vindex MEANS
2244 @cindex means
2245
2246 @display
2247 MEANS [TABLES =]
2248       @{@var{var_list}@}
2249         [ BY @{@var{var_list}@} [BY @{@var{var_list}@} [BY @{@var{var_list}@} @dots{} ]]]
2250
2251       [ /@{@var{var_list}@}
2252          [ BY @{@var{var_list}@} [BY @{@var{var_list}@} [BY @{@var{var_list}@} @dots{} ]]] ]
2253
2254       [/CELLS = [MEAN] [COUNT] [STDDEV] [SEMEAN] [SUM] [MIN] [MAX] [RANGE]
2255         [VARIANCE] [KURT] [SEKURT]
2256         [SKEW] [SESKEW] [FIRST] [LAST]
2257         [HARMONIC] [GEOMETRIC]
2258         [DEFAULT]
2259         [ALL]
2260         [NONE] ]
2261
2262       [/MISSING = [INCLUDE] [DEPENDENT]]
2263 @end display
2264
2265 You can use the @cmd{MEANS} command to calculate the arithmetic mean and similar
2266 statistics, either for the dataset as a whole or for categories of data.
2267
2268 The simplest form of the command is
2269 @example
2270 MEANS @var{v}.
2271 @end example
2272 @noindent which calculates the mean, count and standard deviation for @var{v}.
2273 If you specify a grouping variable, for example
2274 @example
2275 MEANS @var{v} BY @var{g}.
2276 @end example
2277 @noindent then the means, counts and standard deviations for @var{v} after having
2278 been grouped by @var{g} are calculated.
2279 Instead of the mean, count and standard deviation, you could specify the statistics
2280 in which you are interested:
2281 @example
2282 MEANS @var{x} @var{y} BY @var{g}
2283       /CELLS = HARMONIC SUM MIN.
2284 @end example
2285 This example calculates the harmonic mean, the sum and the minimum values of @var{x} and @var{y}
2286 grouped by @var{g}.
2287
2288 The @subcmd{CELLS} subcommand specifies which statistics to calculate.  The available statistics
2289 are:
2290 @itemize
2291 @item @subcmd{MEAN}
2292 @cindex arithmetic mean
2293       The arithmetic mean.
2294 @item @subcmd{COUNT}
2295       The count of the values.
2296 @item @subcmd{STDDEV}
2297       The standard deviation.
2298 @item @subcmd{SEMEAN}
2299       The standard error of the mean.
2300 @item @subcmd{SUM}
2301       The sum of the values.
2302 @item @subcmd{MIN}
2303       The minimum value.
2304 @item @subcmd{MAX}
2305       The maximum value.
2306 @item @subcmd{RANGE}
2307       The difference between the maximum and minimum values.
2308 @item @subcmd{VARIANCE}
2309       The variance.
2310 @item @subcmd{FIRST}
2311       The first value in the category.
2312 @item @subcmd{LAST}
2313       The last value in the category.
2314 @item @subcmd{SKEW}
2315       The skewness.
2316 @item @subcmd{SESKEW}
2317       The standard error of the skewness.
2318 @item @subcmd{KURT}
2319       The kurtosis
2320 @item @subcmd{SEKURT}
2321       The standard error of the kurtosis.
2322 @item @subcmd{HARMONIC}
2323 @cindex harmonic mean
2324       The harmonic mean.
2325 @item @subcmd{GEOMETRIC}
2326 @cindex geometric mean
2327       The geometric mean.
2328 @end itemize
2329
2330 In addition, three special keywords are recognized:
2331 @itemize
2332 @item @subcmd{DEFAULT}
2333       This is the same as @subcmd{MEAN} @subcmd{COUNT} @subcmd{STDDEV}.
2334 @item @subcmd{ALL}
2335       All of the above statistics are calculated.
2336 @item @subcmd{NONE}
2337       No statistics are calculated (only a summary is shown).
2338 @end itemize
2339
2340
2341 More than one @dfn{table} can be specified in a single command.
2342 Each table is separated by a @samp{/}. For
2343 example
2344 @example
2345 MEANS TABLES =
2346       @var{c} @var{d} @var{e} BY @var{x}
2347       /@var{a} @var{b} BY @var{x} @var{y}
2348       /@var{f} BY @var{y} BY @var{z}.
2349 @end example
2350 has three tables (the @samp{TABLE =} is optional).
2351 The first table has three dependent variables @var{c}, @var{d} and @var{e}
2352 and a single categorical variable @var{x}.
2353 The second table has two dependent variables @var{a} and @var{b},
2354 and two categorical variables @var{x} and @var{y}.
2355 The third table has a single dependent variables @var{f}
2356 and a categorical variable formed by the combination of @var{y} and @var{z}.
2357
2358
2359 By default values are omitted from the analysis only if missing values
2360 (either system missing or user missing)
2361 for any of the variables directly involved in their calculation are
2362 encountered.
2363 This behaviour can be modified with the  @subcmd{/MISSING} subcommand.
2364 Three options are possible: @subcmd{TABLE}, @subcmd{INCLUDE} and @subcmd{DEPENDENT}.
2365
2366 @subcmd{/MISSING = INCLUDE} says that user missing values, either in the dependent
2367 variables or in the categorical variables should be taken at their face
2368 value, and not excluded.
2369
2370 @subcmd{/MISSING = DEPENDENT} says that user missing values, in the dependent
2371 variables should be taken at their face value, however cases which
2372 have user missing values for the categorical variables should be omitted
2373 from the calculation.
2374
2375 @subsection Example Means
2376
2377 The dataset in @file{repairs.sav} contains the mean time between failures (@exvar{mtbf})
2378 for a sample of artifacts produced by different factories and trialed under
2379 different operating conditions.
2380 Since there are four combinations of categorical variables, by simply looking
2381 at the list of data, it would be hard to how the scores vary for each category.
2382 @ref{means:ex} shows one way of tabulating the @exvar{mtbf} in a way which is
2383 easier to understand.
2384
2385 @float Example, means:ex
2386 @psppsyntax {means.sps}
2387 @caption {Running @cmd{MEANS} on the @exvar{mtbf} score with categories @exvar{factory} and @exvar{environment}}
2388 @end float
2389
2390 The results are shown in @ref{means:res}.   The figures shown indicate the mean,
2391 standard deviation and number of samples in each category.
2392 These figures however do not indicate whether the results are statistically
2393 significant.  For that, you would need to use the procedures @cmd{ONEWAY}, @cmd{GLM} or
2394 @cmd{T-TEST} depending on the hypothesis being tested.
2395
2396 @float Result, means:res
2397 @psppoutput {means}
2398 @caption {The @exvar{mtbf} categorised by @exvar{factory} and @exvar{environment}}
2399 @end float
2400
2401 Note that there is no limit to the number of variables for which you can calculate
2402 statistics, nor to the number of categorical variables per layer, nor the number
2403 of layers.
2404 However, running @cmd{MEANS} on a large numbers of variables, or with categorical variables
2405 containing a large number of distinct values may result in an extremely large output, which
2406 will not be easy to interpret.
2407 So you should consider carefully which variables to select for participation in the analysis.
2408
2409 @node NPAR TESTS
2410 @section NPAR TESTS
2411
2412 @vindex NPAR TESTS
2413 @cindex nonparametric tests
2414
2415 @display
2416 NPAR TESTS
2417
2418      nonparametric test subcommands
2419      .
2420      .
2421      .
2422
2423      [ /STATISTICS=@{DESCRIPTIVES@} ]
2424
2425      [ /MISSING=@{ANALYSIS, LISTWISE@} @{INCLUDE, EXCLUDE@} ]
2426
2427      [ /METHOD=EXACT [ TIMER [(@var{n})] ] ]
2428 @end display
2429
2430 @cmd{NPAR TESTS} performs nonparametric tests.
2431 Non parametric tests make very few assumptions about the distribution of the
2432 data.
2433 One or more tests may be specified by using the corresponding subcommand.
2434 If the @subcmd{/STATISTICS} subcommand is also specified, then summary statistics are
2435 produces for each variable that is the subject of any test.
2436
2437 Certain tests may take a long time to execute, if an exact figure is required.
2438 Therefore, by default asymptotic approximations are used unless the
2439 subcommand @subcmd{/METHOD=EXACT} is specified.
2440 Exact tests give more accurate results, but may take an unacceptably long
2441 time to perform.  If the @subcmd{TIMER} keyword is used, it sets a maximum time,
2442 after which the test is abandoned, and a warning message printed.
2443 The time, in minutes, should be specified in parentheses after the @subcmd{TIMER} keyword.
2444 If the @subcmd{TIMER} keyword is given without this figure, then a default value of 5 minutes
2445 is used.
2446
2447
2448 @menu
2449 * BINOMIAL::                Binomial Test
2450 * CHISQUARE::               Chi-square Test
2451 * COCHRAN::                 Cochran Q Test
2452 * FRIEDMAN::                Friedman Test
2453 * KENDALL::                 Kendall's W Test
2454 * KOLMOGOROV-SMIRNOV::      Kolmogorov Smirnov Test
2455 * KRUSKAL-WALLIS::          Kruskal-Wallis Test
2456 * MANN-WHITNEY::            Mann Whitney U Test
2457 * MCNEMAR::                 McNemar Test
2458 * MEDIAN::                  Median Test
2459 * RUNS::                    Runs Test
2460 * SIGN::                    The Sign Test
2461 * WILCOXON::                Wilcoxon Signed Ranks Test
2462 @end menu
2463
2464
2465 @node    BINOMIAL
2466 @subsection Binomial test
2467 @vindex BINOMIAL
2468 @cindex binomial test
2469
2470 @display
2471      [ /BINOMIAL[(@var{p})]=@var{var_list}[(@var{value1}[, @var{value2})] ] ]
2472 @end display
2473
2474 The @subcmd{/BINOMIAL} subcommand compares the observed distribution of a dichotomous
2475 variable with that of a binomial distribution.
2476 The variable @var{p} specifies the test proportion of the binomial
2477 distribution.
2478 The default value of 0.5 is assumed if @var{p} is omitted.
2479
2480 If a single value appears after the variable list, then that value is
2481 used as the threshold to partition the observed values. Values less
2482 than or equal to the threshold value form the first category.  Values
2483 greater than the threshold form the second category.
2484
2485 If two values appear after the variable list, then they are used
2486 as the values which a variable must take to be in the respective
2487 category.
2488 Cases for which a variable takes a value equal to neither of the specified
2489 values, take no part in the test for that variable.
2490
2491 If no values appear, then the variable must assume dichotomous
2492 values.
2493 If more than two distinct, non-missing values for a variable
2494 under test are encountered then an error occurs.
2495
2496 If the test proportion is equal to 0.5, then a two tailed test is
2497 reported.   For any other test proportion, a one tailed test is
2498 reported.
2499 For one tailed tests, if the test proportion is less than
2500 or equal to the observed proportion, then the significance of
2501 observing the observed proportion or more is reported.
2502 If the test proportion is more than the observed proportion, then the
2503 significance of observing the observed proportion or less is reported.
2504 That is to say, the test is always performed in the observed
2505 direction.
2506
2507 @pspp{} uses a very precise approximation to the gamma function to
2508 compute the binomial significance.  Thus, exact results are reported
2509 even for very large sample sizes.
2510
2511
2512 @node    CHISQUARE
2513 @subsection Chi-square Test
2514 @vindex CHISQUARE
2515 @cindex chi-square test
2516
2517
2518 @display
2519      [ /CHISQUARE=@var{var_list}[(@var{lo},@var{hi})] [/EXPECTED=@{EQUAL|@var{f1}, @var{f2} @dots{} @var{fn}@}] ]
2520 @end display
2521
2522
2523 The @subcmd{/CHISQUARE} subcommand produces a chi-square statistic for the differences
2524 between the expected and observed frequencies of the categories of a variable.
2525 Optionally, a range of values may appear after the variable list.
2526 If a range is given, then non integer values are truncated, and values
2527 outside the  specified range are excluded from the analysis.
2528
2529 The @subcmd{/EXPECTED} subcommand specifies the expected values of each
2530 category.
2531 There must be exactly one non-zero expected value, for each observed
2532 category, or the @subcmd{EQUAL} keyword must be specified.
2533 You may use the notation @subcmd{@var{n}*@var{f}} to specify @var{n}
2534 consecutive expected categories all taking a frequency of @var{f}.
2535 The frequencies given are proportions, not absolute frequencies.  The
2536 sum of the frequencies need not be 1.
2537 If no @subcmd{/EXPECTED} subcommand is given, then equal frequencies
2538 are expected.
2539
2540 @subsubsection Chi-square Example
2541
2542 A researcher wishes to investigate whether there are an equal number of
2543 persons of each sex in a population.   The sample chosen for invesigation
2544 is that from the @file {physiology.sav} dataset.   The null hypothesis for
2545 the test is that the population comprises an equal number of males and females.
2546 The analysis is performed as shown in @ref{chisquare:ex}.
2547
2548 @float Example, chisquare:ex
2549 @psppsyntax {chisquare.sps}
2550 @caption {Performing a chi-square test to check for equal distribution of sexes}
2551 @end float
2552
2553 There is only one test variable, @i{viz:} @exvar{sex}.  The other variables in the dataset
2554 are ignored.
2555
2556 @float Screenshot, chisquare:scr
2557 @psppimage {chisquare}
2558 @caption {Performing a chi-square test using the graphic user interface}
2559 @end float
2560
2561 In @ref{chisquare:res} the summary box shows that in the sample, there are more males
2562 than females.  However the significance of chi-square result is greater than 0.05
2563 --- the most commonly accepted p-value --- and therefore
2564 there is not enough evidence to reject the null hypothesis and one must conclude
2565 that the evidence does not indicate that there is an imbalance of the sexes
2566 in the population.
2567
2568 @float Result, chisquare:res
2569 @psppoutput {chisquare}
2570 @caption {The results of running a chi-square test on @exvar{sex}}
2571 @end float
2572
2573
2574 @node COCHRAN
2575 @subsection Cochran Q Test
2576 @vindex Cochran
2577 @cindex Cochran Q test
2578 @cindex Q, Cochran Q
2579
2580 @display
2581      [ /COCHRAN = @var{var_list} ]
2582 @end display
2583
2584 The Cochran Q test is used to test for differences between three or more groups.
2585 The data for @var{var_list} in all cases must assume exactly two
2586 distinct values (other than missing values).
2587
2588 The value of Q is displayed along with its Asymptotic significance
2589 based on a chi-square distribution.
2590
2591 @node FRIEDMAN
2592 @subsection Friedman Test
2593 @vindex FRIEDMAN
2594 @cindex Friedman test
2595
2596 @display
2597      [ /FRIEDMAN = @var{var_list} ]
2598 @end display
2599
2600 The Friedman test is used to test for differences between repeated measures when
2601 there is no indication that the distributions are normally distributed.
2602
2603 A list of variables which contain the measured data must be given.  The procedure
2604 prints the sum of ranks for each variable, the test statistic and its significance.
2605
2606 @node KENDALL
2607 @subsection Kendall's W Test
2608 @vindex KENDALL
2609 @cindex Kendall's W test
2610 @cindex coefficient of concordance
2611
2612 @display
2613      [ /KENDALL = @var{var_list} ]
2614 @end display
2615
2616 The Kendall test investigates whether an arbitrary number of related samples come from the
2617 same population.
2618 It is identical to the Friedman test except that the additional statistic W, Kendall's Coefficient of Concordance is printed.
2619 It has the range [0,1] --- a value of zero indicates no agreement between the samples whereas a value of
2620 unity indicates complete agreement.
2621
2622
2623 @node KOLMOGOROV-SMIRNOV
2624 @subsection Kolmogorov-Smirnov Test
2625 @vindex KOLMOGOROV-SMIRNOV
2626 @vindex K-S
2627 @cindex Kolmogorov-Smirnov test
2628
2629 @display
2630      [ /KOLMOGOROV-SMIRNOV (@{NORMAL [@var{mu}, @var{sigma}], UNIFORM [@var{min}, @var{max}], POISSON [@var{lambda}], EXPONENTIAL [@var{scale}] @}) = @var{var_list} ]
2631 @end display
2632
2633 The one sample Kolmogorov-Smirnov subcommand is used to test whether or not a dataset is
2634 drawn from a particular distribution.  Four distributions are supported, @i{viz:}
2635 Normal, Uniform, Poisson and Exponential.
2636
2637 Ideally you should provide the parameters of the distribution against
2638 which you wish to test the data. For example, with the normal
2639 distribution  the mean (@var{mu})and standard deviation (@var{sigma})
2640 should be given; with the uniform distribution, the minimum
2641 (@var{min})and maximum (@var{max}) value should be provided.
2642 However, if the parameters are omitted they are imputed from the
2643 data.  Imputing the parameters reduces the power of the test so should
2644 be avoided if possible.
2645
2646 In the following example, two variables @var{score} and @var{age} are
2647 tested to see if they follow a normal distribution with a mean of 3.5
2648 and a standard deviation of 2.0.
2649 @example
2650   NPAR TESTS
2651         /KOLMOGOROV-SMIRNOV (normal 3.5 2.0) = @var{score} @var{age}.
2652 @end example
2653 If the variables need to be tested against different distributions, then a separate
2654 subcommand must be used.  For example the following syntax tests @var{score} against
2655 a normal distribution with mean of 3.5 and standard deviation of 2.0 whilst @var{age}
2656 is tested against a normal distribution of mean 40 and standard deviation 1.5.
2657 @example
2658   NPAR TESTS
2659         /KOLMOGOROV-SMIRNOV (normal 3.5 2.0) = @var{score}
2660         /KOLMOGOROV-SMIRNOV (normal 40 1.5) =  @var{age}.
2661 @end example
2662
2663 The abbreviated subcommand  @subcmd{K-S} may be used in place of @subcmd{KOLMOGOROV-SMIRNOV}.
2664
2665 @node KRUSKAL-WALLIS
2666 @subsection Kruskal-Wallis Test
2667 @vindex KRUSKAL-WALLIS
2668 @vindex K-W
2669 @cindex Kruskal-Wallis test
2670
2671 @display
2672      [ /KRUSKAL-WALLIS = @var{var_list} BY var (@var{lower}, @var{upper}) ]
2673 @end display
2674
2675 The Kruskal-Wallis test is used to compare data from an
2676 arbitrary number of populations.  It does not assume normality.
2677 The data to be compared are specified by @var{var_list}.
2678 The categorical variable determining the groups to which the
2679 data belongs is given by @var{var}. The limits @var{lower} and
2680 @var{upper} specify the valid range of @var{var}.
2681 If @var{upper} is smaller than @var{lower}, the PSPP will assume their values
2682 to be reversed. Any cases for which @var{var} falls outside
2683 [@var{lower}, @var{upper}] are ignored.
2684
2685 The mean rank of each group as well as the chi-squared value and
2686 significance of the test are printed.
2687 The abbreviated subcommand  @subcmd{K-W} may be used in place of
2688 @subcmd{KRUSKAL-WALLIS}.
2689
2690
2691 @node MANN-WHITNEY
2692 @subsection Mann-Whitney U Test
2693 @vindex MANN-WHITNEY
2694 @vindex M-W
2695 @cindex Mann-Whitney U test
2696 @cindex U, Mann-Whitney U
2697
2698 @display
2699      [ /MANN-WHITNEY = @var{var_list} BY var (@var{group1}, @var{group2}) ]
2700 @end display
2701
2702 The Mann-Whitney subcommand is used to test whether two groups of data
2703 come from different populations. The variables to be tested should be
2704 specified in @var{var_list} and the grouping variable, that determines
2705 to which group the test variables belong, in @var{var}.
2706 @var{Var} may be either a string or an alpha variable.
2707 @var{Group1} and @var{group2} specify the
2708 two values of @var{var} which determine the groups of the test data.
2709 Cases for which the @var{var} value is neither @var{group1} or
2710 @var{group2} are ignored.
2711
2712 The value of the Mann-Whitney U statistic, the Wilcoxon W, and the
2713 significance are printed.
2714 You may abbreviated the subcommand @subcmd{MANN-WHITNEY} to
2715 @subcmd{M-W}.
2716
2717
2718 @node MCNEMAR
2719 @subsection McNemar Test
2720 @vindex MCNEMAR
2721 @cindex McNemar test
2722
2723 @display
2724      [ /MCNEMAR @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
2725 @end display
2726
2727 Use McNemar's test to analyse the significance of the difference between
2728 pairs of correlated proportions.
2729
2730 If the @code{WITH} keyword is omitted, then tests for all
2731 combinations of the listed variables are performed.
2732 If the @code{WITH} keyword is given, and the @code{(PAIRED)} keyword
2733 is also given, then the number of variables preceding @code{WITH}
2734 must be the same as the number following it.
2735 In this case, tests for each respective pair of variables are
2736 performed.
2737 If the @code{WITH} keyword is given, but the
2738 @code{(PAIRED)} keyword is omitted, then tests for each combination
2739 of variable preceding @code{WITH} against variable following
2740 @code{WITH} are performed.
2741
2742 The data in each variable must be dichotomous.  If there are more
2743 than two distinct variables an error will occur and the test will
2744 not be run.
2745
2746 @node MEDIAN
2747 @subsection Median Test
2748 @vindex MEDIAN
2749 @cindex Median test
2750
2751 @display
2752      [ /MEDIAN [(@var{value})] = @var{var_list} BY @var{variable} (@var{value1}, @var{value2}) ]
2753 @end display
2754
2755 The median test is used to test whether independent samples come from
2756 populations with a common median.
2757 The median of the populations against which the samples are to be tested
2758 may be given in parentheses immediately after the
2759 @subcmd{/MEDIAN} subcommand.  If it is not given, the median is imputed from the
2760 union of all the samples.
2761
2762 The variables of the samples to be tested should immediately follow the @samp{=} sign. The
2763 keyword @code{BY} must come next, and then the grouping variable.  Two values
2764 in parentheses should follow.  If the first value is greater than the second,
2765 then a 2 sample test is performed using these two values to determine the groups.
2766 If however, the first variable is less than the second, then a @i{k} sample test is
2767 conducted and the group values used are all values encountered which lie in the
2768 range [@var{value1},@var{value2}].
2769
2770
2771 @node RUNS
2772 @subsection Runs Test
2773 @vindex RUNS
2774 @cindex runs test
2775
2776 @display
2777      [ /RUNS (@{MEAN, MEDIAN, MODE, @var{value}@})  = @var{var_list} ]
2778 @end display
2779
2780 The @subcmd{/RUNS} subcommand tests whether a data sequence is randomly ordered.
2781
2782 It works by examining the number of times a variable's value crosses a given threshold.
2783 The desired threshold must be specified within parentheses.
2784 It may either be specified as a number or as one of @subcmd{MEAN}, @subcmd{MEDIAN} or @subcmd{MODE}.
2785 Following the threshold specification comes the list of variables whose values are to be
2786 tested.
2787
2788 The subcommand shows the number of runs, the asymptotic significance based on the
2789 length of the data.
2790
2791 @node SIGN
2792 @subsection Sign Test
2793 @vindex SIGN
2794 @cindex sign test
2795
2796 @display
2797      [ /SIGN @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
2798 @end display
2799
2800 The @subcmd{/SIGN} subcommand tests for differences between medians of the
2801 variables listed.
2802 The test does not make any assumptions about the
2803 distribution of the data.
2804
2805 If the @code{WITH} keyword is omitted, then tests for all
2806 combinations of the listed variables are performed.
2807 If the @code{WITH} keyword is given, and the @code{(PAIRED)} keyword
2808 is also given, then the number of variables preceding @code{WITH}
2809 must be the same as the number following it.
2810 In this case, tests for each respective pair of variables are
2811 performed.
2812 If the @code{WITH} keyword is given, but the
2813 @code{(PAIRED)} keyword is omitted, then tests for each combination
2814 of variable preceding @code{WITH} against variable following
2815 @code{WITH} are performed.
2816
2817 @node WILCOXON
2818 @subsection Wilcoxon Matched Pairs Signed Ranks Test
2819 @vindex WILCOXON
2820 @cindex wilcoxon matched pairs signed ranks test
2821
2822 @display
2823      [ /WILCOXON @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
2824 @end display
2825
2826 The @subcmd{/WILCOXON} subcommand tests for differences between medians of the
2827 variables listed.
2828 The test does not make any assumptions about the variances of the samples.
2829 It does however assume that the distribution is symmetrical.
2830
2831 If the @subcmd{WITH} keyword is omitted, then tests for all
2832 combinations of the listed variables are performed.
2833 If the @subcmd{WITH} keyword is given, and the @subcmd{(PAIRED)} keyword
2834 is also given, then the number of variables preceding @subcmd{WITH}
2835 must be the same as the number following it.
2836 In this case, tests for each respective pair of variables are
2837 performed.
2838 If the @subcmd{WITH} keyword is given, but the
2839 @subcmd{(PAIRED)} keyword is omitted, then tests for each combination
2840 of variable preceding @subcmd{WITH} against variable following
2841 @subcmd{WITH} are performed.
2842
2843 @node T-TEST
2844 @section T-TEST
2845
2846 @vindex T-TEST
2847
2848 @display
2849 T-TEST
2850         /MISSING=@{ANALYSIS,LISTWISE@} @{EXCLUDE,INCLUDE@}
2851         /CRITERIA=CI(@var{confidence})
2852
2853
2854 (One Sample mode.)
2855         TESTVAL=@var{test_value}
2856         /VARIABLES=@var{var_list}
2857
2858
2859 (Independent Samples mode.)
2860         GROUPS=var(@var{value1} [, @var{value2}])
2861         /VARIABLES=@var{var_list}
2862
2863
2864 (Paired Samples mode.)
2865         PAIRS=@var{var_list} [WITH @var{var_list} [(PAIRED)] ]
2866
2867 @end display
2868
2869
2870 The @cmd{T-TEST} procedure outputs tables used in testing hypotheses about
2871 means.
2872 It operates in one of three modes:
2873 @itemize
2874 @item One Sample mode.
2875 @item Independent Groups mode.
2876 @item Paired mode.
2877 @end itemize
2878
2879 @noindent
2880 Each of these modes are described in more detail below.
2881 There are two optional subcommands which are common to all modes.
2882
2883 The @cmd{/CRITERIA} subcommand tells @pspp{} the confidence interval used
2884 in the tests.  The default value is 0.95.
2885
2886
2887 The @cmd{MISSING} subcommand determines the handling of missing
2888 variables.
2889 If @subcmd{INCLUDE} is set, then user-missing values are included in the
2890 calculations, but system-missing values are not.
2891 If @subcmd{EXCLUDE} is set, which is the default, user-missing
2892 values are excluded as well as system-missing values.
2893 This is the default.
2894
2895 If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
2896 whenever any variable  specified in the @subcmd{/VARIABLES}, @subcmd{/PAIRS} or
2897 @subcmd{/GROUPS} subcommands contains a missing value.
2898 If @subcmd{ANALYSIS} is set, then missing values are excluded only in the analysis for
2899 which they would be needed. This is the default.
2900
2901
2902 @menu
2903 * One Sample Mode::             Testing against a hypothesized mean
2904 * Independent Samples Mode::    Testing two independent groups for equal mean
2905 * Paired Samples Mode::         Testing two interdependent groups for equal mean
2906 @end menu
2907
2908 @node One Sample Mode
2909 @subsection One Sample Mode
2910
2911 The @subcmd{TESTVAL} subcommand invokes the One Sample mode.
2912 This mode is used to test a population mean against a hypothesized
2913 mean.
2914 The value given to the @subcmd{TESTVAL} subcommand is the value against
2915 which you wish to test.
2916 In this mode, you must also use the @subcmd{/VARIABLES} subcommand to
2917 tell @pspp{} which variables you wish to test.
2918
2919 @subsubsection Example - One Sample T-test
2920
2921 A researcher wishes to know whether the weight of persons in a population
2922 is different from the national average.
2923 The samples are drawn from the population under investigation and recorded
2924 in the file @file{physiology.sav}.
2925 From the Department of Health, she
2926 knows that the national average weight of healthy adults is 76.8kg.
2927 Accordingly the @subcmd{TESTVAL} is set to 76.8.
2928 The null hypothesis therefore is that the mean average weight of the
2929 population from which the sample was drawn is 76.8kg.
2930
2931 As previously noted (@pxref{Identifying incorrect data}), one
2932 sample in the dataset contains a weight value
2933 which is clearly incorrect.  So this is excluded from the analysis
2934 using the @cmd{SELECT} command.
2935
2936 @float Example, one-sample-t:ex
2937 @psppsyntax {one-sample-t.sps}
2938 @caption {Running a one sample T-Test after excluding all non-positive values}
2939 @end float
2940
2941 @float Screenshot, one-sample-t:scr
2942 @psppimage {one-sample-t}
2943 @caption {Using the One Sample T-Test dialog box to test @exvar{weight} for a mean of 76.8kg}
2944 @end float
2945
2946
2947 @ref{one-sample-t:res} shows that the mean of our sample differs from the test value
2948 by -1.40kg.  However the significance is very high (0.610).  So one cannot
2949 reject the null hypothesis, and must conclude there is not enough evidence
2950 to suggest that the mean weight of the persons in our population is different
2951 from 76.8kg.
2952
2953 @float Results, one-sample-t:res
2954 @psppoutput {one-sample-t}
2955 @caption {The results of a one sample T-test of @exvar{weight} using a test value of 76.8kg}
2956 @end float
2957
2958 @node Independent Samples Mode
2959 @subsection Independent Samples Mode
2960
2961 The @subcmd{GROUPS} subcommand invokes Independent Samples mode or
2962 `Groups' mode.
2963 This mode is used to test whether two groups of values have the
2964 same population mean.
2965 In this mode, you must also use the @subcmd{/VARIABLES} subcommand to
2966 tell @pspp{} the dependent variables you wish to test.
2967
2968 The variable given in the @subcmd{GROUPS} subcommand is the independent
2969 variable which determines to which group the samples belong.
2970 The values in parentheses are the specific values of the independent
2971 variable for each group.
2972 If the parentheses are omitted and no values are given, the default values
2973 of 1.0 and 2.0 are assumed.
2974
2975 If the independent variable is numeric,
2976 it is acceptable to specify only one value inside the parentheses.
2977 If you do this, cases where the independent variable is
2978 greater than or equal to this value belong to the first group, and cases
2979 less than this value belong to the second group.
2980 When using this form of the @subcmd{GROUPS} subcommand, missing values in
2981 the independent variable are excluded on a listwise basis, regardless
2982 of whether @subcmd{/MISSING=LISTWISE} was specified.
2983
2984 @subsubsection Example - Independent Samples T-test
2985
2986 A researcher wishes to know whether within a population, adult males
2987 are taller than adult females.
2988 The samples are drawn from the population under investigation and recorded
2989 in the file @file{physiology.sav}.
2990
2991 As previously noted (@pxref{Identifying incorrect data}), one
2992 sample in the dataset contains a height value
2993 which is clearly incorrect.  So this is excluded from the analysis
2994 using the @cmd{SELECT} command.
2995
2996
2997 @float Example, indepdendent-samples-t:ex
2998 @psppsyntax {independent-samples-t.sps}
2999 @caption {Running a independent samples T-Test after excluding all observations less than 200kg}
3000 @end float
3001
3002
3003 The null hypothesis is that both males and females are on average
3004 of equal height.
3005
3006 @float Screenshot, independent-samples-t:scr
3007 @psppimage {independent-samples-t}
3008 @caption {Using the Independent Sample T-test dialog, to test for differences of @exvar{height} between values of @exvar{sex}}
3009 @end float
3010
3011
3012 In this case, the grouping variable is @exvar{sex}, so this is entered
3013 as the variable for the @subcmd{GROUP} subcommand.  The group values are  0 (male) and
3014 1 (female).
3015
3016 If you are running the proceedure using syntax, then you need to enter
3017 the values corresponding to each group within parentheses.
3018 If you are using the graphic user interface, then you have to open
3019 the ``Define Groups'' dialog box and enter the values corresponding
3020 to each group as shown in @ref{define-groups-t:scr}.  If, as in this case, the dataset has defined value
3021 labels for the group variable, then you can enter them by label
3022 or by value.
3023
3024 @float Screenshot, define-groups-t:scr
3025 @psppimage {define-groups-t}
3026 @caption {Setting the values of the grouping variable for an Independent Samples T-test}
3027 @end float
3028
3029 From @ref{independent-samples-t:res}, one can clearly see that the @emph{sample} mean height
3030 is greater for males than for females.  However in order to see if this
3031 is a significant result, one must consult the T-Test table.
3032
3033 The T-Test table contains two rows; one for use if the variance of the samples
3034 in each group may be safely assumed to be equal, and the second row
3035 if the variances in each group may not be safely assumed to be equal.
3036
3037 In this case however, both rows show a 2-tailed significance less than 0.001 and
3038 one must therefore reject the null hypothesis and conclude that within
3039 the population the mean height of males and of females are unequal.
3040
3041 @float Result, independent-samples-t:res
3042 @psppoutput {independent-samples-t}
3043 @caption {The results of an independent samples T-test of @exvar{height} by @exvar{sex}}
3044 @end float
3045
3046 @node Paired Samples Mode
3047 @subsection Paired Samples Mode
3048
3049 The @cmd{PAIRS} subcommand introduces Paired Samples mode.
3050 Use this mode when repeated measures have been taken from the same
3051 samples.
3052 If the @subcmd{WITH} keyword is omitted, then tables for all
3053 combinations of variables given in the @cmd{PAIRS} subcommand are
3054 generated.
3055 If the @subcmd{WITH} keyword is given, and the @subcmd{(PAIRED)} keyword
3056 is also given, then the number of variables preceding @subcmd{WITH}
3057 must be the same as the number following it.
3058 In this case, tables for each respective pair of variables are
3059 generated.
3060 In the event that the @subcmd{WITH} keyword is given, but the
3061 @subcmd{(PAIRED)} keyword is omitted, then tables for each combination
3062 of variable preceding @subcmd{WITH} against variable following
3063 @subcmd{WITH} are generated.
3064
3065
3066 @node ONEWAY
3067 @section ONEWAY
3068
3069 @vindex ONEWAY
3070 @cindex analysis of variance
3071 @cindex ANOVA
3072
3073 @display
3074 ONEWAY
3075         [/VARIABLES = ] @var{var_list} BY @var{var}
3076         /MISSING=@{ANALYSIS,LISTWISE@} @{EXCLUDE,INCLUDE@}
3077         /CONTRAST= @var{value1} [, @var{value2}] ... [,@var{valueN}]
3078         /STATISTICS=@{DESCRIPTIVES,HOMOGENEITY@}
3079         /POSTHOC=@{BONFERRONI, GH, LSD, SCHEFFE, SIDAK, TUKEY, ALPHA ([@var{value}])@}
3080 @end display
3081
3082 The @cmd{ONEWAY} procedure performs a one-way analysis of variance of
3083 variables factored by a single independent variable.
3084 It is used to compare the means of a population
3085 divided into more than two groups.
3086
3087 The dependent variables to be analysed should be given in the @subcmd{VARIABLES}
3088 subcommand.
3089 The list of variables must be followed by the @subcmd{BY} keyword and
3090 the name of the independent (or factor) variable.
3091
3092 You can use the @subcmd{STATISTICS} subcommand to tell @pspp{} to display
3093 ancillary information.  The options accepted are:
3094 @itemize
3095 @item DESCRIPTIVES
3096 Displays descriptive statistics about the groups factored by the independent
3097 variable.
3098 @item HOMOGENEITY
3099 Displays the Levene test of Homogeneity of Variance for the
3100 variables and their groups.
3101 @end itemize
3102
3103 The @subcmd{CONTRAST} subcommand is used when you anticipate certain
3104 differences between the groups.
3105 The subcommand must be followed by a list of numerals which are the
3106 coefficients of the groups to be tested.
3107 The number of coefficients must correspond to the number of distinct
3108 groups (or values of the independent variable).
3109 If the total sum of the coefficients are not zero, then @pspp{} will
3110 display a warning, but will proceed with the analysis.
3111 The @subcmd{CONTRAST} subcommand may be given up to 10 times in order
3112 to specify different contrast tests.
3113 The @subcmd{MISSING} subcommand defines how missing values are handled.
3114 If @subcmd{LISTWISE} is specified then cases which have missing values for
3115 the independent variable or any dependent variable are ignored.
3116 If @subcmd{ANALYSIS} is specified, then cases are ignored if the independent
3117 variable is missing or if the dependent variable currently being
3118 analysed is missing.  The default is @subcmd{ANALYSIS}.
3119 A setting of @subcmd{EXCLUDE} means that variables whose values are
3120 user-missing are to be excluded from the analysis. A setting of
3121 @subcmd{INCLUDE} means they are to be included.  The default is @subcmd{EXCLUDE}.
3122
3123 Using the @code{POSTHOC} subcommand you can perform multiple
3124 pairwise comparisons on the data. The following comparison methods
3125 are available:
3126 @itemize
3127 @item @subcmd{LSD}
3128 Least Significant Difference.
3129 @item @subcmd{TUKEY}
3130 Tukey Honestly Significant Difference.
3131 @item @subcmd{BONFERRONI}
3132 Bonferroni test.
3133 @item @subcmd{SCHEFFE}
3134 Scheff@'e's test.
3135 @item @subcmd{SIDAK}
3136 Sidak test.
3137 @item @subcmd{GH}
3138 The Games-Howell test.
3139 @end itemize
3140
3141 @noindent
3142 Use the optional syntax @code{ALPHA(@var{value})} to indicate that
3143 @cmd{ONEWAY} should perform the posthoc tests at a confidence level of
3144 @var{value}.  If @code{ALPHA(@var{value})} is not specified, then the
3145 confidence level used is 0.05.
3146
3147 @node QUICK CLUSTER
3148 @section QUICK CLUSTER
3149 @vindex QUICK CLUSTER
3150
3151 @cindex K-means clustering
3152 @cindex clustering
3153
3154 @display
3155 QUICK CLUSTER @var{var_list}
3156       [/CRITERIA=CLUSTERS(@var{k}) [MXITER(@var{max_iter})] CONVERGE(@var{epsilon}) [NOINITIAL]]
3157       [/MISSING=@{EXCLUDE,INCLUDE@} @{LISTWISE, PAIRWISE@}]
3158       [/PRINT=@{INITIAL@} @{CLUSTER@}]
3159       [/SAVE[=[CLUSTER[(@var{membership_var})]] [DISTANCE[(@var{distance_var})]]]
3160 @end display
3161
3162 The @cmd{QUICK CLUSTER} command performs k-means clustering on the
3163 dataset.  This is useful when you wish to allocate cases into clusters
3164 of similar values and you already know the number of clusters.
3165
3166 The minimum specification is @samp{QUICK CLUSTER} followed by the names
3167 of the variables which contain the cluster data.  Normally you will also
3168 want to specify @subcmd{/CRITERIA=CLUSTERS(@var{k})} where @var{k} is the
3169 number of clusters.  If this is not specified, then @var{k} defaults to 2.
3170
3171 If you use @subcmd{/CRITERIA=NOINITIAL} then a naive algorithm to select
3172 the initial clusters is used.   This will provide for faster execution but
3173 less well separated initial clusters and hence possibly an inferior final
3174 result.
3175
3176
3177 @cmd{QUICK CLUSTER} uses an iterative algorithm to select the clusters centers.
3178 The subcommand  @subcmd{/CRITERIA=MXITER(@var{max_iter})} sets the maximum number of iterations.
3179 During classification, @pspp{} will continue iterating until until @var{max_iter}
3180 iterations have been done or the convergence criterion (see below) is fulfilled.
3181 The default value of @var{max_iter} is 2.
3182
3183 If however, you specify @subcmd{/CRITERIA=NOUPDATE} then after selecting the initial centers,
3184 no further update to the cluster centers is done.  In this case, @var{max_iter}, if specified.
3185 is ignored.
3186
3187 The subcommand  @subcmd{/CRITERIA=CONVERGE(@var{epsilon})} is used
3188 to set the convergence criterion.  The value of convergence criterion is  @var{epsilon}
3189 times the minimum distance between the @emph{initial} cluster centers.  Iteration stops when
3190 the  mean cluster distance between  one iteration and the next
3191 is less than the convergence criterion.  The default value of @var{epsilon} is zero.
3192
3193 The @subcmd{MISSING} subcommand determines the handling of missing variables.
3194 If @subcmd{INCLUDE} is set, then user-missing values are considered at their face
3195 value and not as missing values.
3196 If @subcmd{EXCLUDE} is set, which is the default, user-missing
3197 values are excluded as well as system-missing values.
3198
3199 If @subcmd{LISTWISE} is set, then the entire case is excluded from the analysis
3200 whenever any of the clustering variables contains a missing value.
3201 If @subcmd{PAIRWISE} is set, then a case is considered missing only if all the
3202 clustering variables contain missing values.  Otherwise it is clustered
3203 on the basis of the non-missing values.
3204 The default is @subcmd{LISTWISE}.
3205
3206 The @subcmd{PRINT} subcommand requests additional output to be printed.
3207 If @subcmd{INITIAL} is set, then the initial cluster memberships will
3208 be printed.
3209 If @subcmd{CLUSTER} is set, the cluster memberships of the individual
3210 cases are displayed (potentially generating lengthy output).
3211
3212 You can specify the subcommand @subcmd{SAVE} to ask that each case's cluster membership
3213 and the euclidean distance between the case and its cluster center be saved to
3214 a new variable in the active dataset.   To save the cluster membership use the
3215 @subcmd{CLUSTER} keyword and to save the distance use the @subcmd{DISTANCE} keyword.
3216 Each keyword may optionally be followed by a variable name in parentheses to specify
3217 the new variable which is to contain the saved parameter.  If no variable name is specified,
3218 then PSPP will create one.
3219
3220 @node RANK
3221 @section RANK
3222
3223 @vindex RANK
3224 @display
3225 RANK
3226         [VARIABLES=] @var{var_list} [@{A,D@}] [BY @var{var_list}]
3227         /TIES=@{MEAN,LOW,HIGH,CONDENSE@}
3228         /FRACTION=@{BLOM,TUKEY,VW,RANKIT@}
3229         /PRINT[=@{YES,NO@}
3230         /MISSING=@{EXCLUDE,INCLUDE@}
3231
3232         /RANK [INTO @var{var_list}]
3233         /NTILES(k) [INTO @var{var_list}]
3234         /NORMAL [INTO @var{var_list}]
3235         /PERCENT [INTO @var{var_list}]
3236         /RFRACTION [INTO @var{var_list}]
3237         /PROPORTION [INTO @var{var_list}]
3238         /N [INTO @var{var_list}]
3239         /SAVAGE [INTO @var{var_list}]
3240 @end display
3241
3242 The @cmd{RANK} command ranks variables and stores the results into new
3243 variables.
3244
3245 The @subcmd{VARIABLES} subcommand, which is mandatory, specifies one or
3246 more variables whose values are to be ranked.
3247 After each variable, @samp{A} or @samp{D} may appear, indicating that
3248 the variable is to be ranked in ascending or descending order.
3249 Ascending is the default.
3250 If a @subcmd{BY} keyword appears, it should be followed by a list of variables
3251 which are to serve as group variables.
3252 In this case, the cases are gathered into groups, and ranks calculated
3253 for each group.
3254
3255 The @subcmd{TIES} subcommand specifies how tied values are to be treated.  The
3256 default is to take the mean value of all the tied cases.
3257
3258 The @subcmd{FRACTION} subcommand specifies how proportional ranks are to be
3259 calculated.  This only has any effect if @subcmd{NORMAL} or @subcmd{PROPORTIONAL} rank
3260 functions are requested.
3261
3262 The @subcmd{PRINT} subcommand may be used to specify that a summary of the rank
3263 variables created should appear in the output.
3264
3265 The function subcommands are @subcmd{RANK}, @subcmd{NTILES}, @subcmd{NORMAL}, @subcmd{PERCENT}, @subcmd{RFRACTION},
3266 @subcmd{PROPORTION} and @subcmd{SAVAGE}.  Any number of function subcommands may appear.
3267 If none are given, then the default is RANK.
3268 The @subcmd{NTILES} subcommand must take an integer specifying the number of
3269 partitions into which values should be ranked.
3270 Each subcommand may be followed by the @subcmd{INTO} keyword and a list of
3271 variables which are the variables to be created and receive the rank
3272 scores.  There may be as many variables specified as there are
3273 variables named on the @subcmd{VARIABLES} subcommand.  If fewer are specified,
3274 then the variable names are automatically created.
3275
3276 The @subcmd{MISSING} subcommand determines how user missing values are to be
3277 treated. A setting of @subcmd{EXCLUDE} means that variables whose values are
3278 user-missing are to be excluded from the rank scores. A setting of
3279 @subcmd{INCLUDE} means they are to be included.  The default is @subcmd{EXCLUDE}.
3280
3281 @include regression.texi
3282
3283
3284 @node RELIABILITY
3285 @section RELIABILITY
3286
3287 @vindex RELIABILITY
3288 @display
3289 RELIABILITY
3290         /VARIABLES=@var{var_list}
3291         /SCALE (@var{name}) = @{@var{var_list}, ALL@}
3292         /MODEL=@{ALPHA, SPLIT[(@var{n})]@}
3293         /SUMMARY=@{TOTAL,ALL@}
3294         /MISSING=@{EXCLUDE,INCLUDE@}
3295 @end display
3296
3297 @cindex Cronbach's Alpha
3298 The @cmd{RELIABILITY} command performs reliability analysis on the data.
3299
3300 The @subcmd{VARIABLES} subcommand is required. It determines the set of variables
3301 upon which analysis is to be performed.
3302
3303 The @subcmd{SCALE} subcommand determines the  variables for which
3304 reliability is to be calculated.  If @subcmd{SCALE} is omitted, then analysis for
3305 all variables named in the @subcmd{VARIABLES} subcommand are used.
3306 Optionally, the @var{name} parameter may be specified to set a string name
3307 for the scale.
3308
3309 The @subcmd{MODEL} subcommand determines the type of analysis. If @subcmd{ALPHA} is specified,
3310 then Cronbach's Alpha is calculated for the scale.  If the model is @subcmd{SPLIT},
3311 then the variables  are divided into 2 subsets.  An optional parameter
3312 @var{n} may be given, to specify how many variables to be in the first subset.
3313 If @var{n} is omitted, then it defaults to one half of the variables in the
3314 scale, or one half minus one if there are an odd number of variables.
3315 The default model is @subcmd{ALPHA}.
3316
3317 By default, any cases with user missing, or system missing values for
3318 any variables given in the @subcmd{VARIABLES} subcommand are omitted
3319 from the analysis.  The @subcmd{MISSING} subcommand determines whether
3320 user missing values are included or excluded in the analysis.
3321
3322 The @subcmd{SUMMARY} subcommand determines the type of summary analysis to be performed.
3323 Currently there is only one type: @subcmd{SUMMARY=TOTAL}, which displays per-item
3324 analysis tested against the totals.
3325
3326 @subsection Example - Reliability
3327
3328 Before analysing the results of a survey -- particularly for a multiple choice survey --
3329 it is desireable to know whether the respondents have considered their answers
3330 or simply provided random answers.
3331
3332 In the following example the survey results from the file @file{hotel.sav} are used.
3333 All five survey questions are included in the reliability analysis.
3334 However, before running the analysis, the data must be preprocessed.
3335 An examination of the survey questions reveals that two questions, @i{viz:} v3 and v5
3336 are negatively worded, whereas the others are positively worded.
3337 All questions must be based upon the same scale for the analysis to be meaningful.
3338 One could use the @cmd{RECODE} command (@pxref{RECODE}), however a simpler way is
3339 to use @cmd{COMPUTE} (@pxref{COMPUTE}) and this is what is done in @ref{reliability:ex}.
3340
3341 @float Example, reliability:ex
3342 @psppsyntax {reliability.sps}
3343 @caption {Investigating the reliability of survey responses}
3344 @end float
3345
3346 In this case, all variables in the data set are used.  So we can use the special
3347 keyword @samp{ALL} (@pxref{BNF}).
3348
3349 @float Screenshot, reliability:src
3350 @psppimage {reliability}
3351 @caption {Reliability dialog box with all variables selected}
3352 @end float
3353
3354 @ref{reliability:res} shows that Cronbach's Alpha is 0.11  which is a value normally considered too
3355 low to indicate consistency within the data.  This is possibly due to the small number of
3356 survey questions.  The survey should be redesigned before serious use of the results are
3357 applied.
3358
3359 @float Result, reliability:res
3360 @psppoutput {reliability}
3361 @caption {The results of the reliability command on @file{hotel.sav}}
3362 @end float
3363
3364
3365 @node ROC
3366 @section ROC
3367
3368 @vindex ROC
3369 @cindex Receiver Operating Characteristic
3370 @cindex Area under curve
3371
3372 @display
3373 ROC     @var{var_list} BY @var{state_var} (@var{state_value})
3374         /PLOT = @{ CURVE [(REFERENCE)], NONE @}
3375         /PRINT = [ SE ] [ COORDINATES ]
3376         /CRITERIA = [ CUTOFF(@{INCLUDE,EXCLUDE@}) ]
3377           [ TESTPOS (@{LARGE,SMALL@}) ]
3378           [ CI (@var{confidence}) ]
3379           [ DISTRIBUTION (@{FREE, NEGEXPO @}) ]
3380         /MISSING=@{EXCLUDE,INCLUDE@}
3381 @end display
3382
3383
3384 The @cmd{ROC} command is used to plot the receiver operating characteristic curve
3385 of a dataset, and to estimate the area under the curve.
3386 This is useful for analysing the efficacy of a variable as a predictor of a state of nature.
3387
3388 The mandatory @var{var_list} is the list of predictor variables.
3389 The variable @var{state_var} is the variable whose values represent the actual states,
3390 and @var{state_value} is the value of this variable which represents the positive state.
3391
3392 The optional subcommand @subcmd{PLOT} is used to determine if and how the @subcmd{ROC} curve is drawn.
3393 The keyword @subcmd{CURVE} means that the @subcmd{ROC} curve should be drawn, and the optional keyword @subcmd{REFERENCE},
3394 which should be enclosed in parentheses, says that the diagonal reference line should be drawn.
3395 If the keyword @subcmd{NONE} is given, then no @subcmd{ROC} curve is drawn.
3396 By default, the curve is drawn with no reference line.
3397
3398 The optional subcommand @subcmd{PRINT} determines which additional
3399 tables should be printed.  Two additional tables are available.  The
3400 @subcmd{SE} keyword says that standard error of the area under the
3401 curve should be printed as well as the area itself.  In addition, a
3402 p-value for the null hypothesis that the area under the curve equals
3403 0.5 is printed.   The @subcmd{COORDINATES} keyword says that a
3404 table of coordinates of the @subcmd{ROC} curve should be printed.
3405
3406 The @subcmd{CRITERIA} subcommand has four optional parameters:
3407 @itemize @bullet
3408 @item The @subcmd{TESTPOS} parameter may be @subcmd{LARGE} or @subcmd{SMALL}.
3409 @subcmd{LARGE} is the default, and says that larger values in the predictor variables are to be
3410 considered positive.  @subcmd{SMALL} indicates that smaller values should be considered positive.
3411
3412 @item The @subcmd{CI} parameter specifies the confidence interval that should be printed.
3413 It has no effect if the @subcmd{SE} keyword in the @subcmd{PRINT} subcommand has not been given.
3414
3415 @item The @subcmd{DISTRIBUTION} parameter determines the method to be used when estimating the area
3416 under the curve.
3417 There are two possibilities, @i{viz}: @subcmd{FREE} and @subcmd{NEGEXPO}.
3418 The @subcmd{FREE} method uses a non-parametric estimate, and the @subcmd{NEGEXPO} method a bi-negative
3419 exponential distribution estimate.
3420 The @subcmd{NEGEXPO} method should only be used when the number of positive actual states is
3421 equal to the number of negative actual states.
3422 The default is @subcmd{FREE}.
3423
3424 @item The @subcmd{CUTOFF} parameter is for compatibility and is ignored.
3425 @end itemize
3426
3427 The @subcmd{MISSING} subcommand determines whether user missing values are to
3428 be included or excluded in the analysis.  The default behaviour is to
3429 exclude them.
3430 Cases are excluded on a listwise basis; if any of the variables in @var{var_list}
3431 or if the variable @var{state_var} is missing, then the entire case is
3432 excluded.
3433
3434 @c  LocalWords:  subcmd subcommand