work on docs
[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 section lists the available summary functions.
1189
1190 @menu
1191 * CTABLES Summary Functions::
1192 @end menu
1193
1194 @node CTABLES Summary Functions
1195 @subsubsection Summary Functions
1196
1197 This section lists the summary functions that can be applied to cells
1198 in @code{CTABLES}.  Many of these functions have an @var{area} in
1199 their names, indicating that they summarize over multiple cells within
1200 an area of the output chosen by the user.  The following basic
1201 @var{area}s are supported, in decreasing order of size:
1202
1203 @table @code
1204 @item TABLE
1205 A @dfn{section}.  Stacked variables divide sections of the output from
1206 each other.  sections may span multiple layers.
1207
1208 @item LAYER
1209 A section within a single layer.
1210
1211 @item SUBTABLE
1212 A @dfn{subtable}, whose contents are the cells that pair an innermost
1213 row variable and an innermost column variable within a single layer.
1214 @end table
1215
1216 The following shows how the output for the table expression @code{qn61
1217 > qn57 BY qnd7a > qn86 + qn64b BY qns3a}@footnote{This is not
1218 necessarily a meaningful table, so for clarity variable labels are
1219 omitted.} is divided up into @code{TABLE}, @code{LAYER}, and
1220 @code{SUBTABLE} areas.  Each unique value for Table ID is one section,
1221 and similarly for Layer ID and Subtable ID.  Thus, this output has two
1222 @code{TABLE} areas (one for @code{qnd7a} and one for @code{qn64b}),
1223 four @code{LAYER} areas (for those two variables, per layer), and 12
1224 @code{SUBTABLE} areas.
1225 @psppoutput {ctables22}
1226
1227 @code{CTABLES} also supports the following @var{area}s that further
1228 divide a subtable or a layer within a section:
1229
1230 @table @code
1231 @item LAYERROW
1232 @itemx LAYERCOL
1233 A row or column, respectively, in one layer of a section.
1234
1235 @item ROW
1236 @itemx ROW
1237 A row or column, respectively, in a subtable.
1238 @end table
1239
1240 The following summary functions may be applied to any variable
1241 regardless of whether it is categorical or scalar.  The default label
1242 for each function is listed in parentheses:
1243
1244 @table @asis
1245 @item @code{COUNT} (``Count'')
1246 The sum of weights in a cell.
1247
1248 If @code{CATEGORIES} for one or more of the variables in a table
1249 include missing values (@pxref{CTABLES Per-Variable Category
1250 Options}), then some or all of the categories for a cell might be
1251 missing values.  @code{COUNT} counts data included in a cell
1252 regardless of whether its categories are missing.
1253
1254 @item @code{@i{area}PCT} or @code{@i{area}PCT.COUNT} (``@i{Area} %'')
1255 A percentage within the specified @var{area}.
1256
1257 @item @code{@i{area}PCT.VALIDN} (``@i{Area} Valid N %'')
1258 A percentage of valid values within the specified @var{area}.
1259
1260 @item @code{@i{area}PCT.TOTALN} (``@i{Area} Total N %'')
1261 A percentage of total values within the specified @var{area}.
1262 @end table
1263
1264 The following summary functions apply only to scalar variables or
1265 totals and subtotals for categorical variables.  Be cautious about
1266 interpreting the summary value in the latter case, because it is not
1267 necessarily meaningful; however, the mean of a Likert scale, etc.@:
1268 may have a straightforward interpreation.
1269
1270 @table @asis
1271 @item @code{MAXIMUM} (``Maximum'')
1272 The largest value.
1273
1274 @item @code{MEAN} (``Mean'')
1275 The mean.
1276
1277 @item @code{MEDIAN} (``Median'')
1278 The median value.
1279
1280 @item @code{MINIMUM} (``Minimum'')
1281 The smallest value.
1282
1283 @item @code{MISSING} (``Missing'')
1284 Sum of weights of user- and system-missing values.
1285
1286 @item @code{MODE} (``Mode'')
1287 The highest-frequency value.  Ties are broken by taking the smallest mode.
1288
1289 @item @code{@i{area}PCT.SUM} (``@i{Area} Sum %'')
1290 Percentage of the sum of the values across @var{area}.
1291
1292 @item @code{PTILE} @i{n} (``Percentile @i{n}'')
1293 The @var{n}th percentile, where @math{0 @leq{} @var{n} @leq{} 100}.
1294
1295 @item @code{RANGE} (``Range'')
1296 The maximum minus the minimum.
1297
1298 @item @code{SEMEAN} (``Std Error of Mean'')
1299 The standard error of the mean.
1300
1301 @item @code{STDDEV} (``Std Deviation'')
1302 The standard deviation.
1303
1304 @item @code{SUM} (``Sum'')
1305 The sum.
1306
1307 @item @code{TOTALN} (``Total N'')
1308 The sum of weights in a cell.
1309
1310 For scale data, @code{COUNT} and @code{TOTALN} are the same.
1311
1312 For categorical data, @code{TOTALN} counts missing values in excluded
1313 categories, that is, user-missing values not in an explicit category
1314 list on @code{CATEGORIES} (@pxref{CTABLES Per-Variable Category
1315 Options}), or user-missing values excluded because
1316 @code{MISSING=EXCLUDE} is in effect on @code{CATEGORIES}, or
1317 system-missing values.  @code{COUNT} does not count these.
1318
1319 @item @code{VALIDN} (``Valid N'')
1320 The sum of valid count weights in included categories.
1321
1322 @code{VALIDN} does not count missing values regardless of whether they
1323 are in included categories via @code{CATEGORIES}.  @code{VALIDN} does
1324 not count valid values that are in excluded categories.
1325
1326 @item @code{VARIANCE} (``Variance'')
1327 The variance.
1328 @end table
1329
1330 If the @code{WEIGHT} subcommand specified an adjustment weight
1331 variable, then the following summary functions use its value instead
1332 of the dictionary weight variable.  Otherwise, they are equivalent to
1333 the summary function without the @samp{E}-prefix:
1334
1335 @itemize @bullet
1336 @item
1337 @code{ECOUNT} (``Adjusted Count'')
1338
1339 @item
1340 @code{ETOTALN} (``Adjusted Total N'')
1341
1342 @item
1343 @code{EVALIDN} (``Adjusted Valid N'')
1344 @end itemize
1345
1346 The following summary functions with a @samp{U}-prefix are equivalent
1347 to the same ones without the prefix, except that they use unweighted
1348 counts:
1349
1350 @itemize @bullet
1351 @item
1352 @code{UCOUNT} (``Unweighted Count'')
1353
1354 @item
1355 @code{U@i{area}PCT} or @code{U@i{area}PCT.COUNT} (``Unweighted @i{Area} %'')
1356
1357 @item
1358 @code{U@i{area}PCT.VALIDN} (``Unweighted @i{Area} Valid N %'')
1359
1360 @item
1361 @code{U@i{area}PCT.TOTALN} (``Unweighted @i{Area} Total N %'')
1362
1363 @item
1364 @code{UMEAN} (``Unweighted Mean'')
1365
1366 @item
1367 @code{UMEDIAN} (``Unweighted Median'')
1368
1369 @item
1370 @code{UMISSING} (``Unweighted Missing'')
1371
1372 @item
1373 @code{UMODE} (``Unweight Mode'')
1374
1375 @item
1376 @code{U@i{area}PCT.SUM} (``Unweighted @i{Area} Sum %'')
1377
1378 @item
1379 @code{UPTILE} @i{n} (``Unweighted Percentile @i{n}'') 
1380
1381 @item
1382 @code{USEMEAN} (``Unweighted Std Error of Mean'')
1383
1384 @item
1385 @code{USTDDEV} (``Unweighted Std Deviation'')
1386
1387 @item
1388 @code{USUM} (``Unweighted Sum'')
1389
1390 @item
1391 @code{UTOTALN} (``Unweighted Total N'')
1392
1393 @item
1394 @code{UVALIDN} (``Unweighted Valid N'')
1395
1396 @item
1397 @code{UVARIANCE} (``Unweighted Variance'')
1398 @end itemize
1399
1400 @node CTABLES Statistics Positions and Labels
1401 @subsection Statistics Positions and Labels
1402
1403 @display
1404 @t{/SLABELS}
1405     [@t{POSITION=}@{@t{COLUMN} @math{|} @t{ROW} @math{|} @t{LAYER}@}]
1406     [@t{VISIBLE=}@{@t{YES} @math{|} @t{NO}@}]
1407 @end display
1408
1409 The @code{SLABELS} subcommand controls the position and visibility of
1410 summary statistics for the @code{TABLE} subcommand that it follows.
1411
1412 @code{POSITION} sets the axis on which summary statistics appear.
1413 With @t{POSITION=COLUMN}, which is the default, each summary statistic
1414 appears in a column.  For example:
1415
1416 @example
1417 CTABLES /TABLE=qnd1 [MEAN, MEDIAN] BY qns3a.
1418 @end example
1419 @psppoutput {ctables13}
1420
1421 @noindent
1422 With @t{POSITION=ROW}, each summary statistic appears in a row, as
1423 shown below:
1424
1425 @example
1426 CTABLES /TABLE=qnd1 [MEAN, MEDIAN] BY qns3a /SLABELS POSITION=ROW.
1427 @end example
1428 @psppoutput {ctables14}
1429
1430 @noindent
1431 @t{POSITION=LAYER} is also available to place each summary statistic in
1432 a separate layer.
1433
1434 Labels for summary statistics are shown by default.  Use
1435 @t{VISIBLE=NO} to suppress them.  Because unlabeled data can cause
1436 confusion, it should only be considered if the meaning of the data is
1437 evident, as in a simple case like this:
1438
1439 @example
1440 CTABLES /TABLE=AgeGroup [TABLEPCT] /SLABELS VISIBLE=NO.
1441 @end example
1442 @psppoutput {ctables15}
1443
1444 @node CTABLES Category Label Positions
1445 @subsection Category Label Positions
1446
1447 @display
1448 @t{/CLABELS} @{@t{AUTO} @math{|} @{@t{ROWLABELS}@math{|}@t{COLLABELS}@}@t{=}@{@t{OPPOSITE}@math{|}@t{LAYER}@}@}
1449 @end display
1450
1451 The @code{CLABELS} subcommand controls the position of category labels
1452 for the @code{TABLE} subcommand that it follows.  By default, or if
1453 @t{AUTO} is specified, category labels for a given variable nest
1454 inside the variable's label on the same axis.  For example, the
1455 command below results in age categories nesting within the age group
1456 variable on the rows axis and gender categories within the gender
1457 variable on the columns axis:
1458
1459 @example
1460 CTABLES /TABLE AgeGroup BY qns3a.
1461 @end example
1462 @psppoutput {ctables16}
1463
1464 @t{ROWLABELS=OPPOSITE} or @t{COLLABELS=OPPOSITE} move row or column
1465 variable category labels, respectively, to the opposite axis.  The
1466 setting affects only the innermost variable on the given axis.  For
1467 example:
1468
1469 @example
1470 CTABLES /TABLE AgeGroup BY qns3a /CLABELS ROWLABELS=OPPOSITE.
1471 CTABLES /TABLE AgeGroup BY qns3a /CLABELS COLLABELS=OPPOSITE.
1472 @end example
1473 @psppoutput {ctables17}
1474
1475 @t{ROWLABELS=LAYER} or @t{COLLABELS=LAYER} move the innermost row or
1476 column variable category labels, respectively, to the layer axis.
1477
1478 Only one axis's labels may be moved, whether to the opposite axis or
1479 to the layer axis.
1480
1481 @node CTABLES Per-Variable Category Options
1482 @subsection Per-Variable Category Options
1483
1484 @display
1485 @t{/CATEGORIES} @t{VARIABLES=}@i{variables}
1486     @{@t{[}@i{value}@t{,} @i{value}@dots{}@t{]}
1487    @math{|} [@t{ORDER=}@{@t{A} @math{|} @t{D}@}]
1488      [@t{KEY=}@{@t{VALUE} @math{|} @t{LABEL} @math{|} @i{summary}@t{(}@i{variable}@t{)}@}]
1489      [@t{MISSING=}@{@t{EXCLUDE} @math{|} @t{INCLUDE}@}]@}
1490     [@t{TOTAL=}@{@t{NO} @math{|} @t{YES}@} [@t{LABEL=}@i{string}] [@t{POSITION=}@{@t{AFTER} @math{|} @t{BEFORE}@}]]
1491     [@t{EMPTY=}@{@t{INCLUDE} @math{|} @t{EXCLUDE}@}]
1492 @end display
1493
1494 The @code{CATEGORIES} subcommand specifies, for one or more
1495 categorical variables, the categories to include and exclude, the sort
1496 order for included categories, and treatment of missing values.  It
1497 also controls the totals and subtotals to display.  It may be
1498 specified any number of times, each time for a different set of
1499 variables.  @code{CATEGORIES} applies to the table produced by the
1500 @code{TABLE} subcommand that it follows.
1501
1502 @code{CATEGORIES} does not apply to scalar variables.
1503
1504 @t{VARIABLES} is required.  List the variables for the subcommand
1505 to affect.
1506
1507 There are two way to specify the Categories to include and their sort
1508 order:
1509
1510 @table @asis
1511 @item Explicit categories.
1512 @anchor{CTABLES Explicit Category List}
1513 To explicitly specify categories to include, list the categories
1514 within square brackets in the desired sort order.  Use spaces or
1515 commas to separate values.  Categories not covered by the list are
1516 excluded from analysis.
1517
1518 Each element of the list takes one of the following forms:
1519
1520 @table @t
1521 @item @i{number}
1522 @itemx '@i{string}'
1523 A numeric or string category value, for variables that have the
1524 corresponding type.
1525
1526 @item '@i{date}'
1527 @itemx '@i{time}'
1528 A date or time category value, for variables that have a date or time
1529 print format.
1530
1531 @item @i{min} THRU @i{max}
1532 @itemx LO THRU @i{max}
1533 @itemx @i{min} THRU HI
1534 A range of category values, where @var{min} and @var{max} each takes
1535 one of the forms above, in increasing order.
1536
1537 @item MISSING
1538 All user-missing values.  (To match individual user-missing values,
1539 specify their category values.)
1540
1541 @item OTHERNM
1542 Any non-missing value not covered by any other element of the list
1543 (regardless of where @t{OTHERNM} is placed in the list).
1544
1545 @item &@i{postcompute}
1546 A computed category name (@pxref{CTABLES Computed Categories}).
1547 @end table
1548
1549 Additional forms, described later, allow for subtotals.
1550 If multiple elements of the list cover a given category, the last one
1551 in the list is considered to be a match.
1552
1553 @item Implicit categories.
1554 Without an explicit list of categories, @pspp{} sorts
1555 categories automatically.
1556
1557 The @code{KEY} setting specifies the sort key.  By default, or with
1558 @code{KEY=VALUE}, categories are sorted by default.  Categories may
1559 also be sorted by value label, with @code{KEY=LABEL}, or by the value
1560 of a summary function, e.g.@: @code{KEY=COUNT}.  For summary
1561 functions, a variable name may be specified in parentheses, e.g.@:
1562 @code{KEY=MAXIUM(qnd1)}, and this is required for functions that apply
1563 only to scalar variables.  The @code{PTILE} function also requires a
1564 percentage argument, e.g.@: @code{KEY=PTILE(qnd1, 90)}.  Only summary
1565 functions used in the table may be used, except that @code{COUNT} is
1566 always allowed.
1567
1568 By default, or with @code{ORDER=A}, categories are sorted in ascending
1569 order.  Specify @code{ORDER=D} to sort in descending order.
1570
1571 User-missing values are excluded by default, or with
1572 @code{MISSING=EXCLUDE}.  Specify @code{MISSING=INCLUDE} to include
1573 user-missing values.  The system-missing value is always excluded.
1574 @end table
1575
1576 @subsubheading Totals and Subtotals
1577
1578 @code{CATEGORIES} also controls display of totals and subtotals.
1579 Totals are not displayed by default, or with @code{TOTAL=NO}.  Specify
1580 @code{TOTAL=YES} to display a total.  By default, the total is labeled
1581 ``Total''; use @code{LABEL="@i{label}"} to override it.
1582
1583 Subtotals are also not displayed by default.  To add one or more
1584 subtotals, use an explicit category list and insert @code{SUBTOTAL} or
1585 @code{HSUBTOTAL} in the position or positions where the subtotal
1586 should appear.  With @code{SUBTOTAL}, the subtotal becomes an extra
1587 row or column or layer; @code{HSUBTOTAL} additionally hides the
1588 categories that make up the subtotal.  Either way, the default label
1589 is ``Subtotal'', use @code{SUBTOTAL="@i{label}"} or
1590 @code{HSUBTOTAL="@i{label}"} to specify a custom label.
1591
1592 By default, or with @code{POSITION=AFTER}, totals come after the last
1593 category and subtotals apply to categories that precede them.  With
1594 @code{POSITION=BEFORE}, totals come before the first category and
1595 subtotals apply to categories that follow them.
1596
1597 Only categorical variables may have totals and subtotals.  Scalar
1598 variables may be ``totaled'' indirectly by enabling totals and
1599 subtotals on a categorical variable within which the scalar variable is
1600 summarized.
1601
1602 @subsubheading Categories Without Values
1603
1604 Some categories might not be included in the data set being analyzed.
1605 For example, our example data set has no cases in the ``15 or
1606 younger'' age group.  By default, or with @code{EMPTY=INCLUDE},
1607 @pspp{} includes these empty categories in output tables.  To exclude
1608 them, specify @code{EMPTY=EXCLUDE}.
1609
1610 For implicit categories, empty categories potentially include all the
1611 values with labels for a given variable; for explicit categories, they
1612 include all the values listed individually and all labeled values
1613 covered by ranges or @code{MISSING} or @code{OTHERNM}.
1614
1615 @node CTABLES Titles
1616 @subsection Titles
1617
1618 @display
1619 @t{/TITLES}
1620     [@t{TITLE=}@i{string}@dots{}]
1621     [@t{CAPTION=}@i{string}@dots{}]
1622     [@t{CORNER=}@i{string}@dots{}]
1623 @end display
1624
1625 The @code{TITLES} subcommand sets the title, caption, and corner text
1626 for the table output for the previous @code{TABLE} subcommand.  The
1627 title appears above the table, the caption below the table, and the
1628 corner text appears in the table's upper left corner.  By default, the
1629 title is ``Custom Tables'' and the caption and corner text are empty.
1630
1631 @node CTABLES Table Formatting
1632 @subsection Table Formatting
1633
1634 @display
1635 @t{/FORMAT}
1636     [@t{MINCOLWIDTH=}@{@t{DEFAULT} @math{|} @i{width}@}]
1637     [@t{MAXCOLWIDTH=}@{@t{DEFAULT} @math{|} @i{width}@}]
1638     [@t{UNITS=}@{@t{POINTS} @math{|} @t{INCHES} @math{|} @t{CM}@}]
1639     [@t{EMPTY=}@{@t{ZERO} @math{|} @t{BLANK} @math{|} @i{string}@}]
1640     [@t{MISSING=}@i{string}]
1641 @end display
1642
1643 The @code{FORMAT} subcommand, which must precede the first
1644 @code{TABLE} subcommand, controls formatting for all the output
1645 tables.  @code{FORMAT} and all of its settings are optional.
1646
1647 Use @code{MINCOLWIDTH} and @code{MAXCOLWIDTH} to control the minimum
1648 or maximum width of columns in output tables.  By default, or with
1649 @code{DEFAULT}, column width varies based on content.  Otherwise,
1650 specify a number for either or both of these settings.  If both are
1651 specified, @code{MAXCOLWIDTH} must be bigger than @code{MINCOLWIDTH}.
1652 The default unit, or with @code{UNITS=POINTS}, is points (1/72 inch),
1653 but specify @code{UNITS=INCHES} to use inches or @code{UNITS=CM} for
1654 centimeters.
1655
1656 By default, or with @code{EMPTY=ZERO}, zero values are displayed in
1657 their usual format.  Use @code{EMPTY=BLANK} to use an empty cell
1658 instead, or @code{EMPTY="@i{string}"} to use the specified string.
1659
1660 By default, missing values are displayed as @samp{.}, the same as in
1661 other tables.  Specify @code{MISSING="@i{string}"} to instead use a
1662 custom string.
1663
1664 @node CTABLES Display of Variable Labels
1665 @subsection Display of Variable Labels
1666
1667 @display
1668 @t{/VLABELS}
1669     @t{VARIABLES=}@i{variables}
1670     @t{DISPLAY}=@{@t{DEFAULT} @math{|} @t{NAME} @math{|} @t{LABEL} @math{|} @t{BOTH} @math{|} @t{NONE}@}
1671 @end display
1672
1673 The @code{VLABELS} subcommand, which must precede the first
1674 @code{TABLE} subcommand, controls display of variable labels in all
1675 the output tables.  @code{VLABELS} is optional.  It may appear
1676 multiple times to adjust settings for different variables.
1677
1678 @code{VARIABLES} and @code{DISPLAY} are required.  The value of
1679 @code{DISPLAY} controls how variable labels are displayed for the
1680 variables listed on @code{VARIABLES}.  The supported values are:
1681
1682 @table @code
1683 @item DEFAULT
1684 Uses the setting from @ref{SET TVARS}.
1685
1686 @item NAME
1687 Show only a variable name.
1688
1689 @item LABEL
1690 Show only a variable label.
1691
1692 @item BOTH
1693 Show variable name and label.
1694
1695 @item NONE
1696 Show nothing.
1697 @end table
1698
1699 @node CTABLES Missing Value Treatment
1700 @subsection Missing Value Treatment
1701
1702 @display
1703 @t{/SMISSING} @{@t{VARIABLE} @math{|} @t{LISTWISE}@}
1704 @end display
1705
1706 The @code{SMISSING} subcommand, which must precede the first
1707 @code{TABLE} subcommand, controls treatment of missing values for
1708 scalar variables in producing all the output tables.  @code{SMISSING}
1709 is optional.
1710
1711 With @code{SMISSING=VARIABLE}, which is the default, missing values
1712 are excluded on a variable-by-variable basis.  With
1713 @code{SMISSING=LISTWISE}, when stacked scalar variables are nested
1714 together with a categorical variable, a missing value for any of the
1715 scalar variables causes the case to be excluded for all of them.
1716
1717 As an example, consider the following dataset, in which @samp{x} is a
1718 categorical variable and @samp{y} and @samp{z} are scale:
1719
1720 @psppoutput{ctables18}
1721
1722 @noindent
1723 With the default missing-value treatment, @samp{x}'s mean is 20, based
1724 on the values 10, 20, and 30, and @samp{y}'s mean is 50, based on 40,
1725 50, and 60:
1726
1727 @example
1728 CTABLES /TABLE (y + z) > x.
1729 @end example
1730 @psppoutput{ctables19}
1731
1732 @noindent
1733 By adding @code{SMISSING=LISTWISE}, only cases where @samp{y} and
1734 @samp{z} are both non-missing are considered, so @samp{x}'s mean
1735 becomes 15, as the average of 10 and 20, and @samp{y}'s mean becomes
1736 55, the average of 50 and 60:
1737
1738 @example
1739 CTABLES /SMISSING LISTWISE /TABLE (y + z) > x.
1740 @end example
1741 @psppoutput{ctables20}
1742
1743 @noindent
1744 Even with @code{SMISSING=LISTWISE}, if @samp{y} and @samp{z} are
1745 separately nested with @samp{x}, instead of using a single @samp{>}
1746 operator, missing values revert to being considered on a
1747 variable-by-variable basis:
1748
1749 @example
1750 CTABLES /SMISSING LISTWISE /TABLE (y > x) + (z > x).
1751 @end example
1752 @psppoutput{ctables21}
1753
1754 @node CTABLES Computed Categories
1755 @subsection Computed Categories
1756
1757 @display
1758 @t{/PCOMPUTE} @t{&}@i{postcompute}@t{=EXPR(}@i{expression}@t{)}
1759 @end display
1760
1761 @dfn{Computed categories}, also called @dfn{postcomputes}, are
1762 categories created using arithmetic on categories obtained from the
1763 data.  The @code{PCOMPUTE} subcommand defines computed categories,
1764 which can then be used in two places: on @code{CATEGORIES} within an
1765 explicit category list (@pxref{CTABLES Explicit Category List}), and on
1766 the @code{PPROPERTIES} subcommand to define further properties for a
1767 given postcompute.
1768
1769 @code{PCOMPUTE} must precede the first @code{TABLE} command.  It is
1770 optional and it may be used any number of times to define multiple
1771 postcomputes.
1772
1773 Each @code{PCOMPUTE} defines one postcompute.  Its syntax consists of
1774 a name to identify the postcompute as a @pspp{} identifier prefixed by
1775 @samp{&}, followed by @samp{=} and a postcompute expression enclosed
1776 in @code{EXPR(@dots{})}.  A postcompute expression consists of:
1777
1778 @table @t
1779 @item [@i{category}]
1780 This form evaluates to the summary statistic for @i{category}, e.g.@:
1781 @code{[1]} evaluates to the value of the summary statistic associated
1782 with category 1.  The @i{category} may be a number, a quoted string,
1783 or a quoted time or date value, and all of the categories for a given
1784 postcompute must have the same form.
1785
1786 @item [@i{min} THRU @i{max}]
1787 @itemx [LO THRU @i{max}]
1788 @itemx [@i{min} THRU HI]
1789 @itemx MISSING
1790 @itemx OTHERNM
1791 These forms evaluate to the summary statistics for categories matching
1792 the given syntax, as described in previous sections (@pxref{CTABLES
1793 Explicit Category List}).  If more than one category matches, their
1794 values are summed.
1795
1796 @item SUBTOTAL
1797 The summary statistic for the subtotal category.  This form is allowed
1798 only for variables with exactly one subtotal.
1799
1800 @item SUBTOTAL[@i{index}]
1801 The summary statistic for subtotal category @i{index}, where 1 is the
1802 first subtotal, 2 is the second, and so on.  This form may be used for
1803 any number of subtotals.
1804
1805 @item TOTAL
1806 The summary statistic for the total.
1807
1808 @item @i{a} + @i{b}
1809 @itemx @i{a} - @i{b}
1810 @itemx @i{a} * @i{b}
1811 @itemx @i{a} / @i{b}
1812 @itemx @i{a} ** @i{b}
1813 These forms perform arithmetic on the values of postcompute
1814 expressions @i{a} and @i{b}.  The usual operator precedence rules
1815 apply.
1816
1817 @item @i{number}
1818 Numeric constants may be used in postcompute expressions.
1819
1820 @item (@i{a})
1821 Parentheses override operator precedence.
1822 @end table
1823
1824 A postcompute is not associated with any particular variable.
1825 Instead, it may be referenced within @code{CATEGORIES} for any
1826 suitable variable (e.g.@: only a string variable is suitable for a
1827 postcompute expression that refers to a string category, only a
1828 variable with subtotals for an expression that refers to subtotals,
1829 @dots{}).
1830
1831 Normally a named postcompute is defined only once, but if a later
1832 @code{PCOMPUTE} redefines a postcompute with the same name as an
1833 earlier one, the later one take precedence.
1834
1835 @node CTABLES Computed Category Properties
1836 @subsection Computed Category Properties
1837
1838 @display
1839 @t{/PPROPERTIES} @t{&}@i{postcompute}@dots{}
1840     [@t{LABEL=}@i{string}]
1841     [@t{FORMAT=}[@i{summary} @i{format}]@dots{}]
1842     [@t{HIDESOURCECATS=}@{@t{NO} @math{|} @t{YES}@}
1843 @end display
1844
1845 The @code{PPROPERTIES} subcommand, which must appear before
1846 @code{TABLE}, sets properties for one or more postcomputes defined on
1847 prior @code{PCOMPUTE} subcommands.  The subcommand syntax begins with
1848 the list of postcomputes, each prefixed with @samp{&} as specified on
1849 @code{PCOMPUTE}.
1850
1851 All of the settings on @code{PPROPERTIES} are optional.  Use
1852 @code{LABEL} to set the label shown for the postcomputes in table
1853 output.  The default label for a postcompute is the expression used to
1854 define it.
1855
1856 The @code{FORMAT} setting sets summary statistics and display formats
1857 for the postcomputes.
1858
1859 By default, or with @code{HIDESOURCECATS=NO}, categories referred to
1860 by computed categories are displayed like other categories.  Use
1861 @code{HIDESOURCECATS=YES} to hide them.
1862
1863 @node CTABLES Base Weight
1864 @subsection Base Weight
1865
1866 @display
1867 @t{/WEIGHT VARIABLE=}@i{variable}
1868 @end display
1869
1870 The @code{WEIGHT} subcommand is optional and must appear before
1871 @code{TABLE}.  If it appears, it must name a numeric variable, known
1872 as the @dfn{effective base weight} or @dfn{adjustment weight}.  The
1873 effective base weight variable is used for the @code{ECOUNT},
1874 @code{ETOTALN}, and @code{EVALIDN} summary functions.
1875
1876 Cases with zero, missing, or negative effective base weight are
1877 excluded from all analysis.
1878
1879 Weights obtained from the @pspp{} dictionary are rounded to the
1880 nearest integer.  Effective base weights are not rounded.
1881
1882 @node CTABLES Hiding Small Counts
1883 @subsection Hiding Small Counts
1884
1885 @display
1886 @t{/HIDESMALLCOUNTS COUNT=@i{count}}
1887 @end display
1888
1889 The @code{HIDESMALLCOUNTS} subcommand is optional.  If it specified,
1890 then count values in output tables less than the value of @i{count}
1891 are shown as @code{<@i{count}} instead of their true values.  The
1892 value of @i{count} must be an integer and must be at least 2.  Case
1893 weights are considered for deciding whether to hide a count.
1894
1895 @node FACTOR
1896 @section FACTOR
1897
1898 @vindex FACTOR
1899 @cindex factor analysis
1900 @cindex principal components analysis
1901 @cindex principal axis factoring
1902 @cindex data reduction
1903
1904 @display
1905 FACTOR  @{
1906          VARIABLES=@var{var_list},
1907          MATRIX IN (@{CORR,COV@}=@{*,@var{file_spec}@})
1908         @}
1909
1910         [ /METHOD = @{CORRELATION, COVARIANCE@} ]
1911
1912         [ /ANALYSIS=@var{var_list} ]
1913
1914         [ /EXTRACTION=@{PC, PAF@}]
1915
1916         [ /ROTATION=@{VARIMAX, EQUAMAX, QUARTIMAX, PROMAX[(@var{k})], NOROTATE@}]
1917
1918         [ /PRINT=[INITIAL] [EXTRACTION] [ROTATION] [UNIVARIATE] [CORRELATION] [COVARIANCE] [DET] [KMO] [AIC] [SIG] [ALL] [DEFAULT] ]
1919
1920         [ /PLOT=[EIGEN] ]
1921
1922         [ /FORMAT=[SORT] [BLANK(@var{n})] [DEFAULT] ]
1923
1924         [ /CRITERIA=[FACTORS(@var{n})] [MINEIGEN(@var{l})] [ITERATE(@var{m})] [ECONVERGE (@var{delta})] [DEFAULT] ]
1925
1926         [ /MISSING=[@{LISTWISE, PAIRWISE@}] [@{INCLUDE, EXCLUDE@}] ]
1927 @end display
1928
1929 The @cmd{FACTOR} command performs Factor Analysis or Principal Axis Factoring on a dataset.  It may be used to find
1930 common factors in the data or for data reduction purposes.
1931
1932 The @subcmd{VARIABLES} subcommand is required (unless the @subcmd{MATRIX IN}
1933 subcommand is used).
1934 It lists the variables which are to partake in the analysis.  (The @subcmd{ANALYSIS}
1935 subcommand may optionally further limit the variables that
1936 participate; it is useful primarily in conjunction with @subcmd{MATRIX IN}.)
1937
1938 If @subcmd{MATRIX IN} instead of @subcmd{VARIABLES} is specified, then the analysis
1939 is performed on a pre-prepared correlation or covariance matrix file instead of on
1940 individual data cases.  Typically the matrix file will have been generated by
1941 @cmd{MATRIX DATA} (@pxref{MATRIX DATA}) or provided by a third party.
1942 If specified, @subcmd{MATRIX IN} must be followed by @samp{COV} or @samp{CORR},
1943 then by @samp{=} and @var{file_spec} all in parentheses.
1944 @var{file_spec} may either be an asterisk, which indicates the currently loaded
1945 dataset, or it may be a file name to be loaded. @xref{MATRIX DATA}, for the expected
1946 format of the file.
1947
1948 The @subcmd{/EXTRACTION} subcommand is used to specify the way in which factors
1949 (components) are extracted from the data.
1950 If @subcmd{PC} is specified, then Principal Components Analysis is used.
1951 If @subcmd{PAF} is specified, then Principal Axis Factoring is
1952 used. By default Principal Components Analysis is used.
1953
1954 The @subcmd{/ROTATION} subcommand is used to specify the method by which the
1955 extracted solution is rotated.  Three orthogonal rotation methods are available:
1956 @subcmd{VARIMAX} (which is the default), @subcmd{EQUAMAX}, and @subcmd{QUARTIMAX}.
1957 There is one oblique rotation method, @i{viz}: @subcmd{PROMAX}.
1958 Optionally you may enter the power of the promax rotation @var{k}, which must be enclosed in parentheses.
1959 The default value of @var{k} is 5.
1960 If you don't want any rotation to be performed, the word @subcmd{NOROTATE}
1961 prevents the command from performing any rotation on the data.
1962
1963 The @subcmd{/METHOD} subcommand should be used to determine whether the
1964 covariance matrix or the correlation matrix of the data is
1965 to be analysed.  By default, the correlation matrix is analysed.
1966
1967 The @subcmd{/PRINT} subcommand may be used to select which features of the analysis are reported:
1968
1969 @itemize
1970 @item @subcmd{UNIVARIATE}
1971       A table of mean values, standard deviations and total weights are printed.
1972 @item @subcmd{INITIAL}
1973       Initial communalities and eigenvalues are printed.
1974 @item @subcmd{EXTRACTION}
1975       Extracted communalities and eigenvalues are printed.
1976 @item @subcmd{ROTATION}
1977       Rotated communalities and eigenvalues are printed.
1978 @item @subcmd{CORRELATION}
1979       The correlation matrix is printed.
1980 @item @subcmd{COVARIANCE}
1981       The covariance matrix is printed.
1982 @item @subcmd{DET}
1983       The determinant of the correlation or covariance matrix is printed.
1984 @item @subcmd{AIC}
1985       The anti-image covariance and anti-image correlation matrices are printed.
1986 @item @subcmd{KMO}
1987       The Kaiser-Meyer-Olkin measure of sampling adequacy and the Bartlett test of sphericity is printed.
1988 @item @subcmd{SIG}
1989       The significance of the elements of correlation matrix is printed.
1990 @item @subcmd{ALL}
1991       All of the above are printed.
1992 @item @subcmd{DEFAULT}
1993       Identical to @subcmd{INITIAL} and @subcmd{EXTRACTION}.
1994 @end itemize
1995
1996 If @subcmd{/PLOT=EIGEN} is given, then a ``Scree'' plot of the eigenvalues is
1997 printed.  This can be useful for visualizing the factors and deciding
1998 which factors (components) should be retained.
1999
2000 The @subcmd{/FORMAT} subcommand determined how data are to be
2001 displayed in loading matrices.  If @subcmd{SORT} is specified, then
2002 the variables are sorted in descending order of significance.  If
2003 @subcmd{BLANK(@var{n})} is specified, then coefficients whose absolute
2004 value is less than @var{n} are not printed.  If the keyword
2005 @subcmd{DEFAULT} is specified, or if no @subcmd{/FORMAT} subcommand is
2006 specified, then no sorting is performed, and all coefficients are printed.
2007
2008 You can use the @subcmd{/CRITERIA} subcommand to specify how the number of
2009 extracted factors (components) are chosen.  If @subcmd{FACTORS(@var{n})} is
2010 specified, where @var{n} is an integer, then @var{n} factors are
2011 extracted.  Otherwise, the @subcmd{MINEIGEN} setting is used.
2012 @subcmd{MINEIGEN(@var{l})} requests that all factors whose eigenvalues
2013 are greater than or equal to @var{l} are extracted. The default value
2014 of @var{l} is 1. The @subcmd{ECONVERGE} setting has effect only when
2015 using iterative algorithms for factor extraction (such as Principal Axis
2016 Factoring).  @subcmd{ECONVERGE(@var{delta})} specifies that
2017 iteration should cease when the maximum absolute value of the
2018 communality estimate between one iteration and the previous is less
2019 than @var{delta}. The default value of @var{delta} is 0.001.
2020
2021 The @subcmd{ITERATE(@var{m})} may appear any number of times and is
2022 used for two different purposes. It is used to set the maximum number
2023 of iterations (@var{m}) for convergence and also to set the maximum
2024 number of iterations for rotation.
2025 Whether it affects convergence or rotation depends upon which
2026 subcommand follows the @subcmd{ITERATE} subcommand.
2027 If @subcmd{EXTRACTION} follows, it affects convergence.
2028 If @subcmd{ROTATION} follows, it affects rotation.
2029 If neither @subcmd{ROTATION} nor @subcmd{EXTRACTION} follow a
2030 @subcmd{ITERATE} subcommand, then the entire subcommand is ignored.
2031 The default value of @var{m} is 25.
2032
2033 The @cmd{MISSING} subcommand determines the handling of missing
2034 variables.  If @subcmd{INCLUDE} is set, then user-missing values are
2035 included in the calculations, but system-missing values are not.
2036 If @subcmd{EXCLUDE} is set, which is the default, user-missing
2037 values are excluded as well as system-missing values.  This is the
2038 default. If @subcmd{LISTWISE} is set, then the entire case is excluded
2039 from analysis whenever any variable  specified in the @cmd{VARIABLES}
2040 subcommand contains a missing value.
2041
2042 If @subcmd{PAIRWISE} is set, then a case is considered missing only if
2043 either of the values  for the particular coefficient are missing.
2044 The default is @subcmd{LISTWISE}.
2045
2046 @node GLM
2047 @section GLM
2048
2049 @vindex GLM
2050 @cindex univariate analysis of variance
2051 @cindex fixed effects
2052 @cindex factorial anova
2053 @cindex analysis of variance
2054 @cindex ANOVA
2055
2056
2057 @display
2058 GLM @var{dependent_vars} BY @var{fixed_factors}
2059      [/METHOD = SSTYPE(@var{type})]
2060      [/DESIGN = @var{interaction_0} [@var{interaction_1} [... @var{interaction_n}]]]
2061      [/INTERCEPT = @{INCLUDE|EXCLUDE@}]
2062      [/MISSING = @{INCLUDE|EXCLUDE@}]
2063 @end display
2064
2065 The @cmd{GLM} procedure can be used for fixed effects factorial Anova.
2066
2067 The @var{dependent_vars} are the variables to be analysed.
2068 You may analyse several variables in the same command in which case they should all
2069 appear before the @code{BY} keyword.
2070
2071 The @var{fixed_factors} list must be one or more categorical variables.  Normally it
2072 does not make sense to enter a scalar variable in the @var{fixed_factors} and doing
2073 so may cause @pspp{} to do a lot of unnecessary processing.
2074
2075 The @subcmd{METHOD} subcommand is used to change the method for producing the sums of
2076 squares.  Available values of @var{type} are 1, 2 and 3.  The default is type 3.
2077
2078 You may specify a custom design using the @subcmd{DESIGN} subcommand.
2079 The design comprises a list of interactions where each interaction is a
2080 list of variables separated by a @samp{*}.  For example the command
2081 @display
2082 GLM subject BY sex age_group race
2083     /DESIGN = age_group sex group age_group*sex age_group*race
2084 @end display
2085 @noindent specifies the model @math{subject = age_group + sex + race + age_group*sex + age_group*race}.
2086 If no @subcmd{DESIGN} subcommand is specified, then the default is all possible combinations
2087 of the fixed factors.  That is to say
2088 @display
2089 GLM subject BY sex age_group race
2090 @end display
2091 implies the model
2092 @math{subject = age_group + sex + race + age_group*sex + age_group*race + sex*race + age_group*sex*race}.
2093
2094
2095 The @subcmd{MISSING} subcommand determines the handling of missing
2096 variables.
2097 If @subcmd{INCLUDE} is set then, for the purposes of GLM analysis,
2098 only system-missing values are considered
2099 to be missing; user-missing values are not regarded as missing.
2100 If @subcmd{EXCLUDE} is set, which is the default, then user-missing
2101 values are considered to be missing as well as system-missing values.
2102 A case for which any dependent variable or any factor
2103 variable has a missing value is excluded from the analysis.
2104
2105 @node LOGISTIC REGRESSION
2106 @section LOGISTIC REGRESSION
2107
2108 @vindex LOGISTIC REGRESSION
2109 @cindex logistic regression
2110 @cindex bivariate logistic regression
2111
2112 @display
2113 LOGISTIC REGRESSION [VARIABLES =] @var{dependent_var} WITH @var{predictors}
2114
2115      [/CATEGORICAL = @var{categorical_predictors}]
2116
2117      [@{/NOCONST | /ORIGIN | /NOORIGIN @}]
2118
2119      [/PRINT = [SUMMARY] [DEFAULT] [CI(@var{confidence})] [ALL]]
2120
2121      [/CRITERIA = [BCON(@var{min_delta})] [ITERATE(@var{max_interations})]
2122                   [LCON(@var{min_likelihood_delta})] [EPS(@var{min_epsilon})]
2123                   [CUT(@var{cut_point})]]
2124
2125      [/MISSING = @{INCLUDE|EXCLUDE@}]
2126 @end display
2127
2128 Bivariate Logistic Regression is used when you want to explain a dichotomous dependent
2129 variable in terms of one or more predictor variables.
2130
2131 The minimum command is
2132 @example
2133 LOGISTIC REGRESSION @var{y} WITH @var{x1} @var{x2} @dots{} @var{xn}.
2134 @end example
2135 Here, @var{y} is the dependent variable, which must be dichotomous and @var{x1} @dots{} @var{xn}
2136 are the predictor variables whose coefficients the procedure estimates.
2137
2138 By default, a constant term is included in the model.
2139 Hence, the full model is
2140 @math{
2141 {\bf y}
2142 = b_0 + b_1 {\bf x_1}
2143 + b_2 {\bf x_2}
2144 + \dots
2145 + b_n {\bf x_n}
2146 }
2147
2148 Predictor variables which are categorical in nature should be listed on the @subcmd{/CATEGORICAL} subcommand.
2149 Simple variables as well as interactions between variables may be listed here.
2150
2151 If you want a model without the constant term @math{b_0}, use the keyword @subcmd{/ORIGIN}.
2152 @subcmd{/NOCONST} is a synonym for @subcmd{/ORIGIN}.
2153
2154 An iterative Newton-Raphson procedure is used to fit the model.
2155 The @subcmd{/CRITERIA} subcommand is used to specify the stopping criteria of the procedure,
2156 and other parameters.
2157 The value of @var{cut_point} is used in the classification table.  It is the
2158 threshold above which predicted values are considered to be 1.  Values
2159 of @var{cut_point} must lie in the range [0,1].
2160 During iterations, if any one of the stopping criteria are satisfied, the procedure is
2161 considered complete.
2162 The stopping criteria are:
2163 @itemize
2164 @item The number of iterations exceeds @var{max_iterations}.
2165       The default value of @var{max_iterations} is 20.
2166 @item The change in the all coefficient estimates are less than @var{min_delta}.
2167 The default value of @var{min_delta} is 0.001.
2168 @item The magnitude of change in the likelihood estimate is less than @var{min_likelihood_delta}.
2169 The default value of @var{min_delta} is zero.
2170 This means that this criterion is disabled.
2171 @item The differential of the estimated probability for all cases is less than @var{min_epsilon}.
2172 In other words, the probabilities are close to zero or one.
2173 The default value of @var{min_epsilon} is 0.00000001.
2174 @end itemize
2175
2176
2177 The @subcmd{PRINT} subcommand controls the display of optional statistics.
2178 Currently there is one such option, @subcmd{CI}, which indicates that the
2179 confidence interval of the odds ratio should be displayed as well as its value.
2180 @subcmd{CI} should be followed by an integer in parentheses, to indicate the
2181 confidence level of the desired confidence interval.
2182
2183 The @subcmd{MISSING} subcommand determines the handling of missing
2184 variables.
2185 If @subcmd{INCLUDE} is set, then user-missing values are included in the
2186 calculations, but system-missing values are not.
2187 If @subcmd{EXCLUDE} is set, which is the default, user-missing
2188 values are excluded as well as system-missing values.
2189 This is the default.
2190
2191 @node MEANS
2192 @section MEANS
2193
2194 @vindex MEANS
2195 @cindex means
2196
2197 @display
2198 MEANS [TABLES =]
2199       @{@var{var_list}@}
2200         [ BY @{@var{var_list}@} [BY @{@var{var_list}@} [BY @{@var{var_list}@} @dots{} ]]]
2201
2202       [ /@{@var{var_list}@}
2203          [ BY @{@var{var_list}@} [BY @{@var{var_list}@} [BY @{@var{var_list}@} @dots{} ]]] ]
2204
2205       [/CELLS = [MEAN] [COUNT] [STDDEV] [SEMEAN] [SUM] [MIN] [MAX] [RANGE]
2206         [VARIANCE] [KURT] [SEKURT]
2207         [SKEW] [SESKEW] [FIRST] [LAST]
2208         [HARMONIC] [GEOMETRIC]
2209         [DEFAULT]
2210         [ALL]
2211         [NONE] ]
2212
2213       [/MISSING = [INCLUDE] [DEPENDENT]]
2214 @end display
2215
2216 You can use the @cmd{MEANS} command to calculate the arithmetic mean and similar
2217 statistics, either for the dataset as a whole or for categories of data.
2218
2219 The simplest form of the command is
2220 @example
2221 MEANS @var{v}.
2222 @end example
2223 @noindent which calculates the mean, count and standard deviation for @var{v}.
2224 If you specify a grouping variable, for example
2225 @example
2226 MEANS @var{v} BY @var{g}.
2227 @end example
2228 @noindent then the means, counts and standard deviations for @var{v} after having
2229 been grouped by @var{g} are calculated.
2230 Instead of the mean, count and standard deviation, you could specify the statistics
2231 in which you are interested:
2232 @example
2233 MEANS @var{x} @var{y} BY @var{g}
2234       /CELLS = HARMONIC SUM MIN.
2235 @end example
2236 This example calculates the harmonic mean, the sum and the minimum values of @var{x} and @var{y}
2237 grouped by @var{g}.
2238
2239 The @subcmd{CELLS} subcommand specifies which statistics to calculate.  The available statistics
2240 are:
2241 @itemize
2242 @item @subcmd{MEAN}
2243 @cindex arithmetic mean
2244       The arithmetic mean.
2245 @item @subcmd{COUNT}
2246       The count of the values.
2247 @item @subcmd{STDDEV}
2248       The standard deviation.
2249 @item @subcmd{SEMEAN}
2250       The standard error of the mean.
2251 @item @subcmd{SUM}
2252       The sum of the values.
2253 @item @subcmd{MIN}
2254       The minimum value.
2255 @item @subcmd{MAX}
2256       The maximum value.
2257 @item @subcmd{RANGE}
2258       The difference between the maximum and minimum values.
2259 @item @subcmd{VARIANCE}
2260       The variance.
2261 @item @subcmd{FIRST}
2262       The first value in the category.
2263 @item @subcmd{LAST}
2264       The last value in the category.
2265 @item @subcmd{SKEW}
2266       The skewness.
2267 @item @subcmd{SESKEW}
2268       The standard error of the skewness.
2269 @item @subcmd{KURT}
2270       The kurtosis
2271 @item @subcmd{SEKURT}
2272       The standard error of the kurtosis.
2273 @item @subcmd{HARMONIC}
2274 @cindex harmonic mean
2275       The harmonic mean.
2276 @item @subcmd{GEOMETRIC}
2277 @cindex geometric mean
2278       The geometric mean.
2279 @end itemize
2280
2281 In addition, three special keywords are recognized:
2282 @itemize
2283 @item @subcmd{DEFAULT}
2284       This is the same as @subcmd{MEAN} @subcmd{COUNT} @subcmd{STDDEV}.
2285 @item @subcmd{ALL}
2286       All of the above statistics are calculated.
2287 @item @subcmd{NONE}
2288       No statistics are calculated (only a summary is shown).
2289 @end itemize
2290
2291
2292 More than one @dfn{table} can be specified in a single command.
2293 Each table is separated by a @samp{/}. For
2294 example
2295 @example
2296 MEANS TABLES =
2297       @var{c} @var{d} @var{e} BY @var{x}
2298       /@var{a} @var{b} BY @var{x} @var{y}
2299       /@var{f} BY @var{y} BY @var{z}.
2300 @end example
2301 has three tables (the @samp{TABLE =} is optional).
2302 The first table has three dependent variables @var{c}, @var{d} and @var{e}
2303 and a single categorical variable @var{x}.
2304 The second table has two dependent variables @var{a} and @var{b},
2305 and two categorical variables @var{x} and @var{y}.
2306 The third table has a single dependent variables @var{f}
2307 and a categorical variable formed by the combination of @var{y} and @var{z}.
2308
2309
2310 By default values are omitted from the analysis only if missing values
2311 (either system missing or user missing)
2312 for any of the variables directly involved in their calculation are
2313 encountered.
2314 This behaviour can be modified with the  @subcmd{/MISSING} subcommand.
2315 Three options are possible: @subcmd{TABLE}, @subcmd{INCLUDE} and @subcmd{DEPENDENT}.
2316
2317 @subcmd{/MISSING = INCLUDE} says that user missing values, either in the dependent
2318 variables or in the categorical variables should be taken at their face
2319 value, and not excluded.
2320
2321 @subcmd{/MISSING = DEPENDENT} says that user missing values, in the dependent
2322 variables should be taken at their face value, however cases which
2323 have user missing values for the categorical variables should be omitted
2324 from the calculation.
2325
2326 @subsection Example Means
2327
2328 The dataset in @file{repairs.sav} contains the mean time between failures (@exvar{mtbf})
2329 for a sample of artifacts produced by different factories and trialed under
2330 different operating conditions.
2331 Since there are four combinations of categorical variables, by simply looking
2332 at the list of data, it would be hard to how the scores vary for each category.
2333 @ref{means:ex} shows one way of tabulating the @exvar{mtbf} in a way which is
2334 easier to understand.
2335
2336 @float Example, means:ex
2337 @psppsyntax {means.sps}
2338 @caption {Running @cmd{MEANS} on the @exvar{mtbf} score with categories @exvar{factory} and @exvar{environment}}
2339 @end float
2340
2341 The results are shown in @ref{means:res}.   The figures shown indicate the mean,
2342 standard deviation and number of samples in each category.
2343 These figures however do not indicate whether the results are statistically
2344 significant.  For that, you would need to use the procedures @cmd{ONEWAY}, @cmd{GLM} or
2345 @cmd{T-TEST} depending on the hypothesis being tested.
2346
2347 @float Result, means:res
2348 @psppoutput {means}
2349 @caption {The @exvar{mtbf} categorised by @exvar{factory} and @exvar{environment}}
2350 @end float
2351
2352 Note that there is no limit to the number of variables for which you can calculate
2353 statistics, nor to the number of categorical variables per layer, nor the number
2354 of layers.
2355 However, running @cmd{MEANS} on a large numbers of variables, or with categorical variables
2356 containing a large number of distinct values may result in an extremely large output, which
2357 will not be easy to interpret.
2358 So you should consider carefully which variables to select for participation in the analysis.
2359
2360 @node NPAR TESTS
2361 @section NPAR TESTS
2362
2363 @vindex NPAR TESTS
2364 @cindex nonparametric tests
2365
2366 @display
2367 NPAR TESTS
2368
2369      nonparametric test subcommands
2370      .
2371      .
2372      .
2373
2374      [ /STATISTICS=@{DESCRIPTIVES@} ]
2375
2376      [ /MISSING=@{ANALYSIS, LISTWISE@} @{INCLUDE, EXCLUDE@} ]
2377
2378      [ /METHOD=EXACT [ TIMER [(@var{n})] ] ]
2379 @end display
2380
2381 @cmd{NPAR TESTS} performs nonparametric tests.
2382 Non parametric tests make very few assumptions about the distribution of the
2383 data.
2384 One or more tests may be specified by using the corresponding subcommand.
2385 If the @subcmd{/STATISTICS} subcommand is also specified, then summary statistics are
2386 produces for each variable that is the subject of any test.
2387
2388 Certain tests may take a long time to execute, if an exact figure is required.
2389 Therefore, by default asymptotic approximations are used unless the
2390 subcommand @subcmd{/METHOD=EXACT} is specified.
2391 Exact tests give more accurate results, but may take an unacceptably long
2392 time to perform.  If the @subcmd{TIMER} keyword is used, it sets a maximum time,
2393 after which the test is abandoned, and a warning message printed.
2394 The time, in minutes, should be specified in parentheses after the @subcmd{TIMER} keyword.
2395 If the @subcmd{TIMER} keyword is given without this figure, then a default value of 5 minutes
2396 is used.
2397
2398
2399 @menu
2400 * BINOMIAL::                Binomial Test
2401 * CHISQUARE::               Chi-square Test
2402 * COCHRAN::                 Cochran Q Test
2403 * FRIEDMAN::                Friedman Test
2404 * KENDALL::                 Kendall's W Test
2405 * KOLMOGOROV-SMIRNOV::      Kolmogorov Smirnov Test
2406 * KRUSKAL-WALLIS::          Kruskal-Wallis Test
2407 * MANN-WHITNEY::            Mann Whitney U Test
2408 * MCNEMAR::                 McNemar Test
2409 * MEDIAN::                  Median Test
2410 * RUNS::                    Runs Test
2411 * SIGN::                    The Sign Test
2412 * WILCOXON::                Wilcoxon Signed Ranks Test
2413 @end menu
2414
2415
2416 @node    BINOMIAL
2417 @subsection Binomial test
2418 @vindex BINOMIAL
2419 @cindex binomial test
2420
2421 @display
2422      [ /BINOMIAL[(@var{p})]=@var{var_list}[(@var{value1}[, @var{value2})] ] ]
2423 @end display
2424
2425 The @subcmd{/BINOMIAL} subcommand compares the observed distribution of a dichotomous
2426 variable with that of a binomial distribution.
2427 The variable @var{p} specifies the test proportion of the binomial
2428 distribution.
2429 The default value of 0.5 is assumed if @var{p} is omitted.
2430
2431 If a single value appears after the variable list, then that value is
2432 used as the threshold to partition the observed values. Values less
2433 than or equal to the threshold value form the first category.  Values
2434 greater than the threshold form the second category.
2435
2436 If two values appear after the variable list, then they are used
2437 as the values which a variable must take to be in the respective
2438 category.
2439 Cases for which a variable takes a value equal to neither of the specified
2440 values, take no part in the test for that variable.
2441
2442 If no values appear, then the variable must assume dichotomous
2443 values.
2444 If more than two distinct, non-missing values for a variable
2445 under test are encountered then an error occurs.
2446
2447 If the test proportion is equal to 0.5, then a two tailed test is
2448 reported.   For any other test proportion, a one tailed test is
2449 reported.
2450 For one tailed tests, if the test proportion is less than
2451 or equal to the observed proportion, then the significance of
2452 observing the observed proportion or more is reported.
2453 If the test proportion is more than the observed proportion, then the
2454 significance of observing the observed proportion or less is reported.
2455 That is to say, the test is always performed in the observed
2456 direction.
2457
2458 @pspp{} uses a very precise approximation to the gamma function to
2459 compute the binomial significance.  Thus, exact results are reported
2460 even for very large sample sizes.
2461
2462
2463 @node    CHISQUARE
2464 @subsection Chi-square Test
2465 @vindex CHISQUARE
2466 @cindex chi-square test
2467
2468
2469 @display
2470      [ /CHISQUARE=@var{var_list}[(@var{lo},@var{hi})] [/EXPECTED=@{EQUAL|@var{f1}, @var{f2} @dots{} @var{fn}@}] ]
2471 @end display
2472
2473
2474 The @subcmd{/CHISQUARE} subcommand produces a chi-square statistic for the differences
2475 between the expected and observed frequencies of the categories of a variable.
2476 Optionally, a range of values may appear after the variable list.
2477 If a range is given, then non integer values are truncated, and values
2478 outside the  specified range are excluded from the analysis.
2479
2480 The @subcmd{/EXPECTED} subcommand specifies the expected values of each
2481 category.
2482 There must be exactly one non-zero expected value, for each observed
2483 category, or the @subcmd{EQUAL} keyword must be specified.
2484 You may use the notation @subcmd{@var{n}*@var{f}} to specify @var{n}
2485 consecutive expected categories all taking a frequency of @var{f}.
2486 The frequencies given are proportions, not absolute frequencies.  The
2487 sum of the frequencies need not be 1.
2488 If no @subcmd{/EXPECTED} subcommand is given, then equal frequencies
2489 are expected.
2490
2491 @subsubsection Chi-square Example
2492
2493 A researcher wishes to investigate whether there are an equal number of
2494 persons of each sex in a population.   The sample chosen for invesigation
2495 is that from the @file {physiology.sav} dataset.   The null hypothesis for
2496 the test is that the population comprises an equal number of males and females.
2497 The analysis is performed as shown in @ref{chisquare:ex}.
2498
2499 @float Example, chisquare:ex
2500 @psppsyntax {chisquare.sps}
2501 @caption {Performing a chi-square test to check for equal distribution of sexes}
2502 @end float
2503
2504 There is only one test variable, @i{viz:} @exvar{sex}.  The other variables in the dataset
2505 are ignored.
2506
2507 @float Screenshot, chisquare:scr
2508 @psppimage {chisquare}
2509 @caption {Performing a chi-square test using the graphic user interface}
2510 @end float
2511
2512 In @ref{chisquare:res} the summary box shows that in the sample, there are more males
2513 than females.  However the significance of chi-square result is greater than 0.05
2514 --- the most commonly accepted p-value --- and therefore
2515 there is not enough evidence to reject the null hypothesis and one must conclude
2516 that the evidence does not indicate that there is an imbalance of the sexes
2517 in the population.
2518
2519 @float Result, chisquare:res
2520 @psppoutput {chisquare}
2521 @caption {The results of running a chi-square test on @exvar{sex}}
2522 @end float
2523
2524
2525 @node COCHRAN
2526 @subsection Cochran Q Test
2527 @vindex Cochran
2528 @cindex Cochran Q test
2529 @cindex Q, Cochran Q
2530
2531 @display
2532      [ /COCHRAN = @var{var_list} ]
2533 @end display
2534
2535 The Cochran Q test is used to test for differences between three or more groups.
2536 The data for @var{var_list} in all cases must assume exactly two
2537 distinct values (other than missing values).
2538
2539 The value of Q is displayed along with its Asymptotic significance
2540 based on a chi-square distribution.
2541
2542 @node FRIEDMAN
2543 @subsection Friedman Test
2544 @vindex FRIEDMAN
2545 @cindex Friedman test
2546
2547 @display
2548      [ /FRIEDMAN = @var{var_list} ]
2549 @end display
2550
2551 The Friedman test is used to test for differences between repeated measures when
2552 there is no indication that the distributions are normally distributed.
2553
2554 A list of variables which contain the measured data must be given.  The procedure
2555 prints the sum of ranks for each variable, the test statistic and its significance.
2556
2557 @node KENDALL
2558 @subsection Kendall's W Test
2559 @vindex KENDALL
2560 @cindex Kendall's W test
2561 @cindex coefficient of concordance
2562
2563 @display
2564      [ /KENDALL = @var{var_list} ]
2565 @end display
2566
2567 The Kendall test investigates whether an arbitrary number of related samples come from the
2568 same population.
2569 It is identical to the Friedman test except that the additional statistic W, Kendall's Coefficient of Concordance is printed.
2570 It has the range [0,1] --- a value of zero indicates no agreement between the samples whereas a value of
2571 unity indicates complete agreement.
2572
2573
2574 @node KOLMOGOROV-SMIRNOV
2575 @subsection Kolmogorov-Smirnov Test
2576 @vindex KOLMOGOROV-SMIRNOV
2577 @vindex K-S
2578 @cindex Kolmogorov-Smirnov test
2579
2580 @display
2581      [ /KOLMOGOROV-SMIRNOV (@{NORMAL [@var{mu}, @var{sigma}], UNIFORM [@var{min}, @var{max}], POISSON [@var{lambda}], EXPONENTIAL [@var{scale}] @}) = @var{var_list} ]
2582 @end display
2583
2584 The one sample Kolmogorov-Smirnov subcommand is used to test whether or not a dataset is
2585 drawn from a particular distribution.  Four distributions are supported, @i{viz:}
2586 Normal, Uniform, Poisson and Exponential.
2587
2588 Ideally you should provide the parameters of the distribution against
2589 which you wish to test the data. For example, with the normal
2590 distribution  the mean (@var{mu})and standard deviation (@var{sigma})
2591 should be given; with the uniform distribution, the minimum
2592 (@var{min})and maximum (@var{max}) value should be provided.
2593 However, if the parameters are omitted they are imputed from the
2594 data.  Imputing the parameters reduces the power of the test so should
2595 be avoided if possible.
2596
2597 In the following example, two variables @var{score} and @var{age} are
2598 tested to see if they follow a normal distribution with a mean of 3.5
2599 and a standard deviation of 2.0.
2600 @example
2601   NPAR TESTS
2602         /KOLMOGOROV-SMIRNOV (normal 3.5 2.0) = @var{score} @var{age}.
2603 @end example
2604 If the variables need to be tested against different distributions, then a separate
2605 subcommand must be used.  For example the following syntax tests @var{score} against
2606 a normal distribution with mean of 3.5 and standard deviation of 2.0 whilst @var{age}
2607 is tested against a normal distribution of mean 40 and standard deviation 1.5.
2608 @example
2609   NPAR TESTS
2610         /KOLMOGOROV-SMIRNOV (normal 3.5 2.0) = @var{score}
2611         /KOLMOGOROV-SMIRNOV (normal 40 1.5) =  @var{age}.
2612 @end example
2613
2614 The abbreviated subcommand  @subcmd{K-S} may be used in place of @subcmd{KOLMOGOROV-SMIRNOV}.
2615
2616 @node KRUSKAL-WALLIS
2617 @subsection Kruskal-Wallis Test
2618 @vindex KRUSKAL-WALLIS
2619 @vindex K-W
2620 @cindex Kruskal-Wallis test
2621
2622 @display
2623      [ /KRUSKAL-WALLIS = @var{var_list} BY var (@var{lower}, @var{upper}) ]
2624 @end display
2625
2626 The Kruskal-Wallis test is used to compare data from an
2627 arbitrary number of populations.  It does not assume normality.
2628 The data to be compared are specified by @var{var_list}.
2629 The categorical variable determining the groups to which the
2630 data belongs is given by @var{var}. The limits @var{lower} and
2631 @var{upper} specify the valid range of @var{var}.
2632 If @var{upper} is smaller than @var{lower}, the PSPP will assume their values
2633 to be reversed. Any cases for which @var{var} falls outside
2634 [@var{lower}, @var{upper}] are ignored.
2635
2636 The mean rank of each group as well as the chi-squared value and
2637 significance of the test are printed.
2638 The abbreviated subcommand  @subcmd{K-W} may be used in place of
2639 @subcmd{KRUSKAL-WALLIS}.
2640
2641
2642 @node MANN-WHITNEY
2643 @subsection Mann-Whitney U Test
2644 @vindex MANN-WHITNEY
2645 @vindex M-W
2646 @cindex Mann-Whitney U test
2647 @cindex U, Mann-Whitney U
2648
2649 @display
2650      [ /MANN-WHITNEY = @var{var_list} BY var (@var{group1}, @var{group2}) ]
2651 @end display
2652
2653 The Mann-Whitney subcommand is used to test whether two groups of data
2654 come from different populations. The variables to be tested should be
2655 specified in @var{var_list} and the grouping variable, that determines
2656 to which group the test variables belong, in @var{var}.
2657 @var{Var} may be either a string or an alpha variable.
2658 @var{Group1} and @var{group2} specify the
2659 two values of @var{var} which determine the groups of the test data.
2660 Cases for which the @var{var} value is neither @var{group1} or
2661 @var{group2} are ignored.
2662
2663 The value of the Mann-Whitney U statistic, the Wilcoxon W, and the
2664 significance are printed.
2665 You may abbreviated the subcommand @subcmd{MANN-WHITNEY} to
2666 @subcmd{M-W}.
2667
2668
2669 @node MCNEMAR
2670 @subsection McNemar Test
2671 @vindex MCNEMAR
2672 @cindex McNemar test
2673
2674 @display
2675      [ /MCNEMAR @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
2676 @end display
2677
2678 Use McNemar's test to analyse the significance of the difference between
2679 pairs of correlated proportions.
2680
2681 If the @code{WITH} keyword is omitted, then tests for all
2682 combinations of the listed variables are performed.
2683 If the @code{WITH} keyword is given, and the @code{(PAIRED)} keyword
2684 is also given, then the number of variables preceding @code{WITH}
2685 must be the same as the number following it.
2686 In this case, tests for each respective pair of variables are
2687 performed.
2688 If the @code{WITH} keyword is given, but the
2689 @code{(PAIRED)} keyword is omitted, then tests for each combination
2690 of variable preceding @code{WITH} against variable following
2691 @code{WITH} are performed.
2692
2693 The data in each variable must be dichotomous.  If there are more
2694 than two distinct variables an error will occur and the test will
2695 not be run.
2696
2697 @node MEDIAN
2698 @subsection Median Test
2699 @vindex MEDIAN
2700 @cindex Median test
2701
2702 @display
2703      [ /MEDIAN [(@var{value})] = @var{var_list} BY @var{variable} (@var{value1}, @var{value2}) ]
2704 @end display
2705
2706 The median test is used to test whether independent samples come from
2707 populations with a common median.
2708 The median of the populations against which the samples are to be tested
2709 may be given in parentheses immediately after the
2710 @subcmd{/MEDIAN} subcommand.  If it is not given, the median is imputed from the
2711 union of all the samples.
2712
2713 The variables of the samples to be tested should immediately follow the @samp{=} sign. The
2714 keyword @code{BY} must come next, and then the grouping variable.  Two values
2715 in parentheses should follow.  If the first value is greater than the second,
2716 then a 2 sample test is performed using these two values to determine the groups.
2717 If however, the first variable is less than the second, then a @i{k} sample test is
2718 conducted and the group values used are all values encountered which lie in the
2719 range [@var{value1},@var{value2}].
2720
2721
2722 @node RUNS
2723 @subsection Runs Test
2724 @vindex RUNS
2725 @cindex runs test
2726
2727 @display
2728      [ /RUNS (@{MEAN, MEDIAN, MODE, @var{value}@})  = @var{var_list} ]
2729 @end display
2730
2731 The @subcmd{/RUNS} subcommand tests whether a data sequence is randomly ordered.
2732
2733 It works by examining the number of times a variable's value crosses a given threshold.
2734 The desired threshold must be specified within parentheses.
2735 It may either be specified as a number or as one of @subcmd{MEAN}, @subcmd{MEDIAN} or @subcmd{MODE}.
2736 Following the threshold specification comes the list of variables whose values are to be
2737 tested.
2738
2739 The subcommand shows the number of runs, the asymptotic significance based on the
2740 length of the data.
2741
2742 @node SIGN
2743 @subsection Sign Test
2744 @vindex SIGN
2745 @cindex sign test
2746
2747 @display
2748      [ /SIGN @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
2749 @end display
2750
2751 The @subcmd{/SIGN} subcommand tests for differences between medians of the
2752 variables listed.
2753 The test does not make any assumptions about the
2754 distribution of the data.
2755
2756 If the @code{WITH} keyword is omitted, then tests for all
2757 combinations of the listed variables are performed.
2758 If the @code{WITH} keyword is given, and the @code{(PAIRED)} keyword
2759 is also given, then the number of variables preceding @code{WITH}
2760 must be the same as the number following it.
2761 In this case, tests for each respective pair of variables are
2762 performed.
2763 If the @code{WITH} keyword is given, but the
2764 @code{(PAIRED)} keyword is omitted, then tests for each combination
2765 of variable preceding @code{WITH} against variable following
2766 @code{WITH} are performed.
2767
2768 @node WILCOXON
2769 @subsection Wilcoxon Matched Pairs Signed Ranks Test
2770 @vindex WILCOXON
2771 @cindex wilcoxon matched pairs signed ranks test
2772
2773 @display
2774      [ /WILCOXON @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
2775 @end display
2776
2777 The @subcmd{/WILCOXON} subcommand tests for differences between medians of the
2778 variables listed.
2779 The test does not make any assumptions about the variances of the samples.
2780 It does however assume that the distribution is symmetrical.
2781
2782 If the @subcmd{WITH} keyword is omitted, then tests for all
2783 combinations of the listed variables are performed.
2784 If the @subcmd{WITH} keyword is given, and the @subcmd{(PAIRED)} keyword
2785 is also given, then the number of variables preceding @subcmd{WITH}
2786 must be the same as the number following it.
2787 In this case, tests for each respective pair of variables are
2788 performed.
2789 If the @subcmd{WITH} keyword is given, but the
2790 @subcmd{(PAIRED)} keyword is omitted, then tests for each combination
2791 of variable preceding @subcmd{WITH} against variable following
2792 @subcmd{WITH} are performed.
2793
2794 @node T-TEST
2795 @section T-TEST
2796
2797 @vindex T-TEST
2798
2799 @display
2800 T-TEST
2801         /MISSING=@{ANALYSIS,LISTWISE@} @{EXCLUDE,INCLUDE@}
2802         /CRITERIA=CI(@var{confidence})
2803
2804
2805 (One Sample mode.)
2806         TESTVAL=@var{test_value}
2807         /VARIABLES=@var{var_list}
2808
2809
2810 (Independent Samples mode.)
2811         GROUPS=var(@var{value1} [, @var{value2}])
2812         /VARIABLES=@var{var_list}
2813
2814
2815 (Paired Samples mode.)
2816         PAIRS=@var{var_list} [WITH @var{var_list} [(PAIRED)] ]
2817
2818 @end display
2819
2820
2821 The @cmd{T-TEST} procedure outputs tables used in testing hypotheses about
2822 means.
2823 It operates in one of three modes:
2824 @itemize
2825 @item One Sample mode.
2826 @item Independent Groups mode.
2827 @item Paired mode.
2828 @end itemize
2829
2830 @noindent
2831 Each of these modes are described in more detail below.
2832 There are two optional subcommands which are common to all modes.
2833
2834 The @cmd{/CRITERIA} subcommand tells @pspp{} the confidence interval used
2835 in the tests.  The default value is 0.95.
2836
2837
2838 The @cmd{MISSING} subcommand determines the handling of missing
2839 variables.
2840 If @subcmd{INCLUDE} is set, then user-missing values are included in the
2841 calculations, but system-missing values are not.
2842 If @subcmd{EXCLUDE} is set, which is the default, user-missing
2843 values are excluded as well as system-missing values.
2844 This is the default.
2845
2846 If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
2847 whenever any variable  specified in the @subcmd{/VARIABLES}, @subcmd{/PAIRS} or
2848 @subcmd{/GROUPS} subcommands contains a missing value.
2849 If @subcmd{ANALYSIS} is set, then missing values are excluded only in the analysis for
2850 which they would be needed. This is the default.
2851
2852
2853 @menu
2854 * One Sample Mode::             Testing against a hypothesized mean
2855 * Independent Samples Mode::    Testing two independent groups for equal mean
2856 * Paired Samples Mode::         Testing two interdependent groups for equal mean
2857 @end menu
2858
2859 @node One Sample Mode
2860 @subsection One Sample Mode
2861
2862 The @subcmd{TESTVAL} subcommand invokes the One Sample mode.
2863 This mode is used to test a population mean against a hypothesized
2864 mean.
2865 The value given to the @subcmd{TESTVAL} subcommand is the value against
2866 which you wish to test.
2867 In this mode, you must also use the @subcmd{/VARIABLES} subcommand to
2868 tell @pspp{} which variables you wish to test.
2869
2870 @subsubsection Example - One Sample T-test
2871
2872 A researcher wishes to know whether the weight of persons in a population
2873 is different from the national average.
2874 The samples are drawn from the population under investigation and recorded
2875 in the file @file{physiology.sav}.
2876 From the Department of Health, she
2877 knows that the national average weight of healthy adults is 76.8kg.
2878 Accordingly the @subcmd{TESTVAL} is set to 76.8.
2879 The null hypothesis therefore is that the mean average weight of the
2880 population from which the sample was drawn is 76.8kg.
2881
2882 As previously noted (@pxref{Identifying incorrect data}), one
2883 sample in the dataset contains a weight value
2884 which is clearly incorrect.  So this is excluded from the analysis
2885 using the @cmd{SELECT} command.
2886
2887 @float Example, one-sample-t:ex
2888 @psppsyntax {one-sample-t.sps}
2889 @caption {Running a one sample T-Test after excluding all non-positive values}
2890 @end float
2891
2892 @float Screenshot, one-sample-t:scr
2893 @psppimage {one-sample-t}
2894 @caption {Using the One Sample T-Test dialog box to test @exvar{weight} for a mean of 76.8kg}
2895 @end float
2896
2897
2898 @ref{one-sample-t:res} shows that the mean of our sample differs from the test value
2899 by -1.40kg.  However the significance is very high (0.610).  So one cannot
2900 reject the null hypothesis, and must conclude there is not enough evidence
2901 to suggest that the mean weight of the persons in our population is different
2902 from 76.8kg.
2903
2904 @float Results, one-sample-t:res
2905 @psppoutput {one-sample-t}
2906 @caption {The results of a one sample T-test of @exvar{weight} using a test value of 76.8kg}
2907 @end float
2908
2909 @node Independent Samples Mode
2910 @subsection Independent Samples Mode
2911
2912 The @subcmd{GROUPS} subcommand invokes Independent Samples mode or
2913 `Groups' mode.
2914 This mode is used to test whether two groups of values have the
2915 same population mean.
2916 In this mode, you must also use the @subcmd{/VARIABLES} subcommand to
2917 tell @pspp{} the dependent variables you wish to test.
2918
2919 The variable given in the @subcmd{GROUPS} subcommand is the independent
2920 variable which determines to which group the samples belong.
2921 The values in parentheses are the specific values of the independent
2922 variable for each group.
2923 If the parentheses are omitted and no values are given, the default values
2924 of 1.0 and 2.0 are assumed.
2925
2926 If the independent variable is numeric,
2927 it is acceptable to specify only one value inside the parentheses.
2928 If you do this, cases where the independent variable is
2929 greater than or equal to this value belong to the first group, and cases
2930 less than this value belong to the second group.
2931 When using this form of the @subcmd{GROUPS} subcommand, missing values in
2932 the independent variable are excluded on a listwise basis, regardless
2933 of whether @subcmd{/MISSING=LISTWISE} was specified.
2934
2935 @subsubsection Example - Independent Samples T-test
2936
2937 A researcher wishes to know whether within a population, adult males
2938 are taller than adult females.
2939 The samples are drawn from the population under investigation and recorded
2940 in the file @file{physiology.sav}.
2941
2942 As previously noted (@pxref{Identifying incorrect data}), one
2943 sample in the dataset contains a height value
2944 which is clearly incorrect.  So this is excluded from the analysis
2945 using the @cmd{SELECT} command.
2946
2947
2948 @float Example, indepdendent-samples-t:ex
2949 @psppsyntax {independent-samples-t.sps}
2950 @caption {Running a independent samples T-Test after excluding all observations less than 200kg}
2951 @end float
2952
2953
2954 The null hypothesis is that both males and females are on average
2955 of equal height.
2956
2957 @float Screenshot, independent-samples-t:scr
2958 @psppimage {independent-samples-t}
2959 @caption {Using the Independent Sample T-test dialog, to test for differences of @exvar{height} between values of @exvar{sex}}
2960 @end float
2961
2962
2963 In this case, the grouping variable is @exvar{sex}, so this is entered
2964 as the variable for the @subcmd{GROUP} subcommand.  The group values are  0 (male) and
2965 1 (female).
2966
2967 If you are running the proceedure using syntax, then you need to enter
2968 the values corresponding to each group within parentheses.
2969 If you are using the graphic user interface, then you have to open
2970 the ``Define Groups'' dialog box and enter the values corresponding
2971 to each group as shown in @ref{define-groups-t:scr}.  If, as in this case, the dataset has defined value
2972 labels for the group variable, then you can enter them by label
2973 or by value.
2974
2975 @float Screenshot, define-groups-t:scr
2976 @psppimage {define-groups-t}
2977 @caption {Setting the values of the grouping variable for an Independent Samples T-test}
2978 @end float
2979
2980 From @ref{independent-samples-t:res}, one can clearly see that the @emph{sample} mean height
2981 is greater for males than for females.  However in order to see if this
2982 is a significant result, one must consult the T-Test table.
2983
2984 The T-Test table contains two rows; one for use if the variance of the samples
2985 in each group may be safely assumed to be equal, and the second row
2986 if the variances in each group may not be safely assumed to be equal.
2987
2988 In this case however, both rows show a 2-tailed significance less than 0.001 and
2989 one must therefore reject the null hypothesis and conclude that within
2990 the population the mean height of males and of females are unequal.
2991
2992 @float Result, independent-samples-t:res
2993 @psppoutput {independent-samples-t}
2994 @caption {The results of an independent samples T-test of @exvar{height} by @exvar{sex}}
2995 @end float
2996
2997 @node Paired Samples Mode
2998 @subsection Paired Samples Mode
2999
3000 The @cmd{PAIRS} subcommand introduces Paired Samples mode.
3001 Use this mode when repeated measures have been taken from the same
3002 samples.
3003 If the @subcmd{WITH} keyword is omitted, then tables for all
3004 combinations of variables given in the @cmd{PAIRS} subcommand are
3005 generated.
3006 If the @subcmd{WITH} keyword is given, and the @subcmd{(PAIRED)} keyword
3007 is also given, then the number of variables preceding @subcmd{WITH}
3008 must be the same as the number following it.
3009 In this case, tables for each respective pair of variables are
3010 generated.
3011 In the event that the @subcmd{WITH} keyword is given, but the
3012 @subcmd{(PAIRED)} keyword is omitted, then tables for each combination
3013 of variable preceding @subcmd{WITH} against variable following
3014 @subcmd{WITH} are generated.
3015
3016
3017 @node ONEWAY
3018 @section ONEWAY
3019
3020 @vindex ONEWAY
3021 @cindex analysis of variance
3022 @cindex ANOVA
3023
3024 @display
3025 ONEWAY
3026         [/VARIABLES = ] @var{var_list} BY @var{var}
3027         /MISSING=@{ANALYSIS,LISTWISE@} @{EXCLUDE,INCLUDE@}
3028         /CONTRAST= @var{value1} [, @var{value2}] ... [,@var{valueN}]
3029         /STATISTICS=@{DESCRIPTIVES,HOMOGENEITY@}
3030         /POSTHOC=@{BONFERRONI, GH, LSD, SCHEFFE, SIDAK, TUKEY, ALPHA ([@var{value}])@}
3031 @end display
3032
3033 The @cmd{ONEWAY} procedure performs a one-way analysis of variance of
3034 variables factored by a single independent variable.
3035 It is used to compare the means of a population
3036 divided into more than two groups.
3037
3038 The dependent variables to be analysed should be given in the @subcmd{VARIABLES}
3039 subcommand.
3040 The list of variables must be followed by the @subcmd{BY} keyword and
3041 the name of the independent (or factor) variable.
3042
3043 You can use the @subcmd{STATISTICS} subcommand to tell @pspp{} to display
3044 ancillary information.  The options accepted are:
3045 @itemize
3046 @item DESCRIPTIVES
3047 Displays descriptive statistics about the groups factored by the independent
3048 variable.
3049 @item HOMOGENEITY
3050 Displays the Levene test of Homogeneity of Variance for the
3051 variables and their groups.
3052 @end itemize
3053
3054 The @subcmd{CONTRAST} subcommand is used when you anticipate certain
3055 differences between the groups.
3056 The subcommand must be followed by a list of numerals which are the
3057 coefficients of the groups to be tested.
3058 The number of coefficients must correspond to the number of distinct
3059 groups (or values of the independent variable).
3060 If the total sum of the coefficients are not zero, then @pspp{} will
3061 display a warning, but will proceed with the analysis.
3062 The @subcmd{CONTRAST} subcommand may be given up to 10 times in order
3063 to specify different contrast tests.
3064 The @subcmd{MISSING} subcommand defines how missing values are handled.
3065 If @subcmd{LISTWISE} is specified then cases which have missing values for
3066 the independent variable or any dependent variable are ignored.
3067 If @subcmd{ANALYSIS} is specified, then cases are ignored if the independent
3068 variable is missing or if the dependent variable currently being
3069 analysed is missing.  The default is @subcmd{ANALYSIS}.
3070 A setting of @subcmd{EXCLUDE} means that variables whose values are
3071 user-missing are to be excluded from the analysis. A setting of
3072 @subcmd{INCLUDE} means they are to be included.  The default is @subcmd{EXCLUDE}.
3073
3074 Using the @code{POSTHOC} subcommand you can perform multiple
3075 pairwise comparisons on the data. The following comparison methods
3076 are available:
3077 @itemize
3078 @item @subcmd{LSD}
3079 Least Significant Difference.
3080 @item @subcmd{TUKEY}
3081 Tukey Honestly Significant Difference.
3082 @item @subcmd{BONFERRONI}
3083 Bonferroni test.
3084 @item @subcmd{SCHEFFE}
3085 Scheff@'e's test.
3086 @item @subcmd{SIDAK}
3087 Sidak test.
3088 @item @subcmd{GH}
3089 The Games-Howell test.
3090 @end itemize
3091
3092 @noindent
3093 Use the optional syntax @code{ALPHA(@var{value})} to indicate that
3094 @cmd{ONEWAY} should perform the posthoc tests at a confidence level of
3095 @var{value}.  If @code{ALPHA(@var{value})} is not specified, then the
3096 confidence level used is 0.05.
3097
3098 @node QUICK CLUSTER
3099 @section QUICK CLUSTER
3100 @vindex QUICK CLUSTER
3101
3102 @cindex K-means clustering
3103 @cindex clustering
3104
3105 @display
3106 QUICK CLUSTER @var{var_list}
3107       [/CRITERIA=CLUSTERS(@var{k}) [MXITER(@var{max_iter})] CONVERGE(@var{epsilon}) [NOINITIAL]]
3108       [/MISSING=@{EXCLUDE,INCLUDE@} @{LISTWISE, PAIRWISE@}]
3109       [/PRINT=@{INITIAL@} @{CLUSTER@}]
3110       [/SAVE[=[CLUSTER[(@var{membership_var})]] [DISTANCE[(@var{distance_var})]]]
3111 @end display
3112
3113 The @cmd{QUICK CLUSTER} command performs k-means clustering on the
3114 dataset.  This is useful when you wish to allocate cases into clusters
3115 of similar values and you already know the number of clusters.
3116
3117 The minimum specification is @samp{QUICK CLUSTER} followed by the names
3118 of the variables which contain the cluster data.  Normally you will also
3119 want to specify @subcmd{/CRITERIA=CLUSTERS(@var{k})} where @var{k} is the
3120 number of clusters.  If this is not specified, then @var{k} defaults to 2.
3121
3122 If you use @subcmd{/CRITERIA=NOINITIAL} then a naive algorithm to select
3123 the initial clusters is used.   This will provide for faster execution but
3124 less well separated initial clusters and hence possibly an inferior final
3125 result.
3126
3127
3128 @cmd{QUICK CLUSTER} uses an iterative algorithm to select the clusters centers.
3129 The subcommand  @subcmd{/CRITERIA=MXITER(@var{max_iter})} sets the maximum number of iterations.
3130 During classification, @pspp{} will continue iterating until until @var{max_iter}
3131 iterations have been done or the convergence criterion (see below) is fulfilled.
3132 The default value of @var{max_iter} is 2.
3133
3134 If however, you specify @subcmd{/CRITERIA=NOUPDATE} then after selecting the initial centers,
3135 no further update to the cluster centers is done.  In this case, @var{max_iter}, if specified.
3136 is ignored.
3137
3138 The subcommand  @subcmd{/CRITERIA=CONVERGE(@var{epsilon})} is used
3139 to set the convergence criterion.  The value of convergence criterion is  @var{epsilon}
3140 times the minimum distance between the @emph{initial} cluster centers.  Iteration stops when
3141 the  mean cluster distance between  one iteration and the next
3142 is less than the convergence criterion.  The default value of @var{epsilon} is zero.
3143
3144 The @subcmd{MISSING} subcommand determines the handling of missing variables.
3145 If @subcmd{INCLUDE} is set, then user-missing values are considered at their face
3146 value and not as missing values.
3147 If @subcmd{EXCLUDE} is set, which is the default, user-missing
3148 values are excluded as well as system-missing values.
3149
3150 If @subcmd{LISTWISE} is set, then the entire case is excluded from the analysis
3151 whenever any of the clustering variables contains a missing value.
3152 If @subcmd{PAIRWISE} is set, then a case is considered missing only if all the
3153 clustering variables contain missing values.  Otherwise it is clustered
3154 on the basis of the non-missing values.
3155 The default is @subcmd{LISTWISE}.
3156
3157 The @subcmd{PRINT} subcommand requests additional output to be printed.
3158 If @subcmd{INITIAL} is set, then the initial cluster memberships will
3159 be printed.
3160 If @subcmd{CLUSTER} is set, the cluster memberships of the individual
3161 cases are displayed (potentially generating lengthy output).
3162
3163 You can specify the subcommand @subcmd{SAVE} to ask that each case's cluster membership
3164 and the euclidean distance between the case and its cluster center be saved to
3165 a new variable in the active dataset.   To save the cluster membership use the
3166 @subcmd{CLUSTER} keyword and to save the distance use the @subcmd{DISTANCE} keyword.
3167 Each keyword may optionally be followed by a variable name in parentheses to specify
3168 the new variable which is to contain the saved parameter.  If no variable name is specified,
3169 then PSPP will create one.
3170
3171 @node RANK
3172 @section RANK
3173
3174 @vindex RANK
3175 @display
3176 RANK
3177         [VARIABLES=] @var{var_list} [@{A,D@}] [BY @var{var_list}]
3178         /TIES=@{MEAN,LOW,HIGH,CONDENSE@}
3179         /FRACTION=@{BLOM,TUKEY,VW,RANKIT@}
3180         /PRINT[=@{YES,NO@}
3181         /MISSING=@{EXCLUDE,INCLUDE@}
3182
3183         /RANK [INTO @var{var_list}]
3184         /NTILES(k) [INTO @var{var_list}]
3185         /NORMAL [INTO @var{var_list}]
3186         /PERCENT [INTO @var{var_list}]
3187         /RFRACTION [INTO @var{var_list}]
3188         /PROPORTION [INTO @var{var_list}]
3189         /N [INTO @var{var_list}]
3190         /SAVAGE [INTO @var{var_list}]
3191 @end display
3192
3193 The @cmd{RANK} command ranks variables and stores the results into new
3194 variables.
3195
3196 The @subcmd{VARIABLES} subcommand, which is mandatory, specifies one or
3197 more variables whose values are to be ranked.
3198 After each variable, @samp{A} or @samp{D} may appear, indicating that
3199 the variable is to be ranked in ascending or descending order.
3200 Ascending is the default.
3201 If a @subcmd{BY} keyword appears, it should be followed by a list of variables
3202 which are to serve as group variables.
3203 In this case, the cases are gathered into groups, and ranks calculated
3204 for each group.
3205
3206 The @subcmd{TIES} subcommand specifies how tied values are to be treated.  The
3207 default is to take the mean value of all the tied cases.
3208
3209 The @subcmd{FRACTION} subcommand specifies how proportional ranks are to be
3210 calculated.  This only has any effect if @subcmd{NORMAL} or @subcmd{PROPORTIONAL} rank
3211 functions are requested.
3212
3213 The @subcmd{PRINT} subcommand may be used to specify that a summary of the rank
3214 variables created should appear in the output.
3215
3216 The function subcommands are @subcmd{RANK}, @subcmd{NTILES}, @subcmd{NORMAL}, @subcmd{PERCENT}, @subcmd{RFRACTION},
3217 @subcmd{PROPORTION} and @subcmd{SAVAGE}.  Any number of function subcommands may appear.
3218 If none are given, then the default is RANK.
3219 The @subcmd{NTILES} subcommand must take an integer specifying the number of
3220 partitions into which values should be ranked.
3221 Each subcommand may be followed by the @subcmd{INTO} keyword and a list of
3222 variables which are the variables to be created and receive the rank
3223 scores.  There may be as many variables specified as there are
3224 variables named on the @subcmd{VARIABLES} subcommand.  If fewer are specified,
3225 then the variable names are automatically created.
3226
3227 The @subcmd{MISSING} subcommand determines how user missing values are to be
3228 treated. A setting of @subcmd{EXCLUDE} means that variables whose values are
3229 user-missing are to be excluded from the rank scores. A setting of
3230 @subcmd{INCLUDE} means they are to be included.  The default is @subcmd{EXCLUDE}.
3231
3232 @include regression.texi
3233
3234
3235 @node RELIABILITY
3236 @section RELIABILITY
3237
3238 @vindex RELIABILITY
3239 @display
3240 RELIABILITY
3241         /VARIABLES=@var{var_list}
3242         /SCALE (@var{name}) = @{@var{var_list}, ALL@}
3243         /MODEL=@{ALPHA, SPLIT[(@var{n})]@}
3244         /SUMMARY=@{TOTAL,ALL@}
3245         /MISSING=@{EXCLUDE,INCLUDE@}
3246 @end display
3247
3248 @cindex Cronbach's Alpha
3249 The @cmd{RELIABILITY} command performs reliability analysis on the data.
3250
3251 The @subcmd{VARIABLES} subcommand is required. It determines the set of variables
3252 upon which analysis is to be performed.
3253
3254 The @subcmd{SCALE} subcommand determines the  variables for which
3255 reliability is to be calculated.  If @subcmd{SCALE} is omitted, then analysis for
3256 all variables named in the @subcmd{VARIABLES} subcommand are used.
3257 Optionally, the @var{name} parameter may be specified to set a string name
3258 for the scale.
3259
3260 The @subcmd{MODEL} subcommand determines the type of analysis. If @subcmd{ALPHA} is specified,
3261 then Cronbach's Alpha is calculated for the scale.  If the model is @subcmd{SPLIT},
3262 then the variables  are divided into 2 subsets.  An optional parameter
3263 @var{n} may be given, to specify how many variables to be in the first subset.
3264 If @var{n} is omitted, then it defaults to one half of the variables in the
3265 scale, or one half minus one if there are an odd number of variables.
3266 The default model is @subcmd{ALPHA}.
3267
3268 By default, any cases with user missing, or system missing values for
3269 any variables given in the @subcmd{VARIABLES} subcommand are omitted
3270 from the analysis.  The @subcmd{MISSING} subcommand determines whether
3271 user missing values are included or excluded in the analysis.
3272
3273 The @subcmd{SUMMARY} subcommand determines the type of summary analysis to be performed.
3274 Currently there is only one type: @subcmd{SUMMARY=TOTAL}, which displays per-item
3275 analysis tested against the totals.
3276
3277 @subsection Example - Reliability
3278
3279 Before analysing the results of a survey -- particularly for a multiple choice survey --
3280 it is desireable to know whether the respondents have considered their answers
3281 or simply provided random answers.
3282
3283 In the following example the survey results from the file @file{hotel.sav} are used.
3284 All five survey questions are included in the reliability analysis.
3285 However, before running the analysis, the data must be preprocessed.
3286 An examination of the survey questions reveals that two questions, @i{viz:} v3 and v5
3287 are negatively worded, whereas the others are positively worded.
3288 All questions must be based upon the same scale for the analysis to be meaningful.
3289 One could use the @cmd{RECODE} command (@pxref{RECODE}), however a simpler way is
3290 to use @cmd{COMPUTE} (@pxref{COMPUTE}) and this is what is done in @ref{reliability:ex}.
3291
3292 @float Example, reliability:ex
3293 @psppsyntax {reliability.sps}
3294 @caption {Investigating the reliability of survey responses}
3295 @end float
3296
3297 In this case, all variables in the data set are used.  So we can use the special
3298 keyword @samp{ALL} (@pxref{BNF}).
3299
3300 @float Screenshot, reliability:src
3301 @psppimage {reliability}
3302 @caption {Reliability dialog box with all variables selected}
3303 @end float
3304
3305 @ref{reliability:res} shows that Cronbach's Alpha is 0.11  which is a value normally considered too
3306 low to indicate consistency within the data.  This is possibly due to the small number of
3307 survey questions.  The survey should be redesigned before serious use of the results are
3308 applied.
3309
3310 @float Result, reliability:res
3311 @psppoutput {reliability}
3312 @caption {The results of the reliability command on @file{hotel.sav}}
3313 @end float
3314
3315
3316 @node ROC
3317 @section ROC
3318
3319 @vindex ROC
3320 @cindex Receiver Operating Characteristic
3321 @cindex Area under curve
3322
3323 @display
3324 ROC     @var{var_list} BY @var{state_var} (@var{state_value})
3325         /PLOT = @{ CURVE [(REFERENCE)], NONE @}
3326         /PRINT = [ SE ] [ COORDINATES ]
3327         /CRITERIA = [ CUTOFF(@{INCLUDE,EXCLUDE@}) ]
3328           [ TESTPOS (@{LARGE,SMALL@}) ]
3329           [ CI (@var{confidence}) ]
3330           [ DISTRIBUTION (@{FREE, NEGEXPO @}) ]
3331         /MISSING=@{EXCLUDE,INCLUDE@}
3332 @end display
3333
3334
3335 The @cmd{ROC} command is used to plot the receiver operating characteristic curve
3336 of a dataset, and to estimate the area under the curve.
3337 This is useful for analysing the efficacy of a variable as a predictor of a state of nature.
3338
3339 The mandatory @var{var_list} is the list of predictor variables.
3340 The variable @var{state_var} is the variable whose values represent the actual states,
3341 and @var{state_value} is the value of this variable which represents the positive state.
3342
3343 The optional subcommand @subcmd{PLOT} is used to determine if and how the @subcmd{ROC} curve is drawn.
3344 The keyword @subcmd{CURVE} means that the @subcmd{ROC} curve should be drawn, and the optional keyword @subcmd{REFERENCE},
3345 which should be enclosed in parentheses, says that the diagonal reference line should be drawn.
3346 If the keyword @subcmd{NONE} is given, then no @subcmd{ROC} curve is drawn.
3347 By default, the curve is drawn with no reference line.
3348
3349 The optional subcommand @subcmd{PRINT} determines which additional
3350 tables should be printed.  Two additional tables are available.  The
3351 @subcmd{SE} keyword says that standard error of the area under the
3352 curve should be printed as well as the area itself.  In addition, a
3353 p-value for the null hypothesis that the area under the curve equals
3354 0.5 is printed.   The @subcmd{COORDINATES} keyword says that a
3355 table of coordinates of the @subcmd{ROC} curve should be printed.
3356
3357 The @subcmd{CRITERIA} subcommand has four optional parameters:
3358 @itemize @bullet
3359 @item The @subcmd{TESTPOS} parameter may be @subcmd{LARGE} or @subcmd{SMALL}.
3360 @subcmd{LARGE} is the default, and says that larger values in the predictor variables are to be
3361 considered positive.  @subcmd{SMALL} indicates that smaller values should be considered positive.
3362
3363 @item The @subcmd{CI} parameter specifies the confidence interval that should be printed.
3364 It has no effect if the @subcmd{SE} keyword in the @subcmd{PRINT} subcommand has not been given.
3365
3366 @item The @subcmd{DISTRIBUTION} parameter determines the method to be used when estimating the area
3367 under the curve.
3368 There are two possibilities, @i{viz}: @subcmd{FREE} and @subcmd{NEGEXPO}.
3369 The @subcmd{FREE} method uses a non-parametric estimate, and the @subcmd{NEGEXPO} method a bi-negative
3370 exponential distribution estimate.
3371 The @subcmd{NEGEXPO} method should only be used when the number of positive actual states is
3372 equal to the number of negative actual states.
3373 The default is @subcmd{FREE}.
3374
3375 @item The @subcmd{CUTOFF} parameter is for compatibility and is ignored.
3376 @end itemize
3377
3378 The @subcmd{MISSING} subcommand determines whether user missing values are to
3379 be included or excluded in the analysis.  The default behaviour is to
3380 exclude them.
3381 Cases are excluded on a listwise basis; if any of the variables in @var{var_list}
3382 or if the variable @var{state_var} is missing, then the entire case is
3383 excluded.
3384
3385 @c  LocalWords:  subcmd subcommand