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