Checkin of new directory structure.
[pspp-builds.git] / doc / data-io.texi
1 @node Data Input and Output, System and Portable Files, Expressions, Top
2 @chapter Data Input and Output
3 @cindex input
4 @cindex output
5 @cindex data
6 @cindex cases
7 @cindex observations
8
9 Data are the focus of the PSPP language.  
10 Each datum  belongs to a @dfn{case} (also called an @dfn{observation}).
11 Each case represents an individual or ``experimental unit''.
12 For example, in the results of a survey, the names of the respondents,
13 their sex, age, etc.@: and their responses are all data and the data
14 pertaining to single respondent is a case.
15 This chapter examines
16 the PSPP commands for defining variables and reading and writing data.
17
18 @quotation Note
19 These commands tell PSPP how to read data, but the data will not
20 actually be read until a procedure is executed.
21 @end quotation
22
23 @menu
24 * BEGIN DATA::                  Embed data within a syntax file.
25 * CLEAR TRANSFORMATIONS::       Clear pending transformations.
26 * CLOSE FILE HANDLE::           Close a file handle.
27 * DATA LIST::                   Fundamental data reading command.
28 * END CASE::                    Output the current case.
29 * END FILE::                    Terminate the current input program.
30 * FILE HANDLE::                 Support for special file formats.
31 * INPUT PROGRAM::               Support for complex input programs.
32 * LIST::                        List cases in the active file.
33 * MATRIX DATA::                 Read matrices in text format.
34 * NEW FILE::                    Clear the active file and dictionary.
35 * PRINT::                       Display values in print formats.
36 * PRINT EJECT::                 Eject the current page then print.
37 * PRINT SPACE::                 Print blank lines.
38 * REREAD::                      Take another look at the previous input line.
39 * REPEATING DATA::              Multiple cases on a single line.
40 * WRITE::                       Display values in write formats.
41 @end menu
42
43 @node BEGIN DATA
44 @section BEGIN DATA
45 @vindex BEGIN DATA
46 @vindex END DATA
47 @cindex Embedding data in syntax files
48 @cindex Data, embedding in syntax files
49
50 @display
51 BEGIN DATA.
52 @dots{}
53 END DATA.
54 @end display
55
56 @cmd{BEGIN DATA} and @cmd{END DATA} can be used to embed raw ASCII
57 data in a PSPP syntax file.  @cmd{DATA LIST} or another input
58 procedure must be used before @cmd{BEGIN DATA} (@pxref{DATA LIST}).
59 @cmd{BEGIN DATA} and @cmd{END DATA} must be used together.  @cmd{END
60 DATA} must appear by itself on a single line, with no leading
61 white space and exactly one space between the words @code{END} and
62 @code{DATA}, like this:
63
64 @example
65 END DATA.
66 @end example
67
68 @node CLEAR TRANSFORMATIONS
69 @section CLEAR TRANSFORMATIONS
70 @vindex CLEAR TRANSFORMATIONS
71
72 @display
73 CLEAR TRANSFORMATIONS.
74 @end display
75
76 @cmd{CLEAR TRANSFORMATIONS} clears out all pending
77 transformations.  It does not cancel the current input program.
78
79 @node CLOSE FILE HANDLE
80 @section CLOSE FILE HANDLE
81
82 @display
83 CLOSE FILE HANDLE handle_name.
84 @end display
85
86 @cmd{CLOSE FILE HANDLE} disassociates the name of a file handle with a
87 given file.  The only specification is the name of the handle to close.
88 Afterward
89 @cmd{FILE HANDLE}.
90
91 If the file handle name refers to a scratch file, then the storage
92 associated with the scratch file in memory or on disk will be freed.
93 If the scratch file is in use, e.g.@: it has been specified on a
94 @cmd{GET} command whose execution has not completed, then freeing is
95 delayed until it is no longer in use.
96
97 The file named INLINE, which represents data entered between @cmd{BEGIN
98 DATA} and @cmd{END DATA}, cannot be closed.  Attempts to close it with
99 @cmd{CLOSE FILE HANDLE} have no effect.
100
101 @cmd{CLOSE FILE HANDLE} is a PSPP extension.
102
103 @node DATA LIST
104 @section DATA LIST
105 @vindex DATA LIST
106 @cindex reading data from a file
107 @cindex data, reading from a file
108 @cindex data, embedding in syntax files
109 @cindex embedding data in syntax files
110
111 Used to read text or binary data, @cmd{DATA LIST} is the most
112 fundamental data-reading command.  Even the more sophisticated input
113 methods use @cmd{DATA LIST} commands as a building block.
114 Understanding @cmd{DATA LIST} is important to understanding how to use
115 PSPP to read your data files.
116
117 There are two major variants of @cmd{DATA LIST}, which are fixed
118 format and free format.  In addition, free format has a minor variant,
119 list format, which is discussed in terms of its differences from vanilla
120 free format.
121
122 Each form of @cmd{DATA LIST} is described in detail below.
123
124 @menu
125 * DATA LIST FIXED::             Fixed columnar locations for data.
126 * DATA LIST FREE::              Any spacing you like.
127 * DATA LIST LIST::              Each case must be on a single line.
128 @end menu
129
130 @node DATA LIST FIXED
131 @subsection DATA LIST FIXED
132 @vindex DATA LIST FIXED
133 @cindex reading fixed-format data
134 @cindex fixed-format data, reading
135 @cindex data, fixed-format, reading
136 @cindex embedding fixed-format data
137
138 @display
139 DATA LIST [FIXED]
140         @{TABLE,NOTABLE@}
141         FILE='filename'
142         RECORDS=record_count
143         END=end_var
144         /[line_no] var_spec@dots{}
145
146 where each var_spec takes one of the forms
147         var_list start-end [type_spec]
148         var_list (fortran_spec)
149 @end display
150
151 @cmd{DATA LIST FIXED} is used to read data files that have values at fixed
152 positions on each line of single-line or multiline records.  The
153 keyword FIXED is optional.
154
155 The FILE subcommand must be used if input is to be taken from an
156 external file.  It may be used to specify a filename as a string or a
157 file handle (@pxref{File Handles}).  If the FILE subcommand is not used,
158 then input is assumed to be specified within the command file using
159 @cmd{BEGIN DATA}@dots{}@cmd{END DATA} (@pxref{BEGIN DATA}).
160
161 The optional RECORDS subcommand, which takes a single integer as an
162 argument, is used to specify the number of lines per record.  If RECORDS
163 is not specified, then the number of lines per record is calculated from
164 the list of variable specifications later in @cmd{DATA LIST}.
165
166 The END subcommand is only useful in conjunction with @cmd{INPUT
167 PROGRAM}.  @xref{INPUT PROGRAM}, for details.
168
169 @cmd{DATA LIST} can optionally output a table describing how the data file
170 will be read.  The TABLE subcommand enables this output, and NOTABLE
171 disables it.  The default is to output the table.
172
173 The list of variables to be read from the data list must come last.
174 Each line in the data record is introduced by a slash (@samp{/}).
175 Optionally, a line number may follow the slash.  Following, any number
176 of variable specifications may be present.
177
178 Each variable specification consists of a list of variable names
179 followed by a description of their location on the input line.  Sets of
180 variables may be specified using the @code{DATA LIST} TO convention
181 (@pxref{Sets of
182 Variables}).  There are two ways to specify the location of the variable
183 on the line: columnar style and FORTRAN style.
184
185 In columnar style, the starting column and ending column for the field
186 are specified after the variable name, separated by a dash (@samp{-}).
187 For instance, the third through fifth columns on a line would be
188 specified @samp{3-5}.  By default, variables are considered to be in
189 @samp{F} format (@pxref{Input/Output Formats}).  (This default can be
190 changed; see @ref{SET} for more information.)
191
192 In columnar style, to use a variable format other than the default,
193 specify the format type in parentheses after the column numbers.  For
194 instance, for alphanumeric @samp{A} format, use @samp{(A)}.  
195
196 In addition, implied decimal places can be specified in parentheses
197 after the column numbers.  As an example, suppose that a data file has a
198 field in which the characters @samp{1234} should be interpreted as
199 having the value 12.34.  Then this field has two implied decimal places,
200 and the corresponding specification would be @samp{(2)}.  If a field
201 that has implied decimal places contains a decimal point, then the
202 implied decimal places are not applied.
203
204 Changing the variable format and adding implied decimal places can be
205 done together; for instance, @samp{(N,5)}.
206
207 When using columnar style, the input and output width of each variable is
208 computed from the field width.  The field width must be evenly divisible
209 into the number of variables specified.
210
211 FORTRAN style is an altogether different approach to specifying field
212 locations.  With this approach, a list of variable input format
213 specifications, separated by commas, are placed after the variable names
214 inside parentheses.  Each format specifier advances as many characters
215 into the input line as it uses.
216
217 Implied decimal places also exist in FORTRAN style.  A format
218 specification with @var{d} decimal places also has @var{d} implied
219 decimal places.
220
221 In addition to the standard format specifiers (@pxref{Input/Output
222 Formats}), FORTRAN style defines some extensions:
223
224 @table @asis
225 @item @code{X}
226 Advance the current column on this line by one character position.
227
228 @item @code{T}@var{x}
229 Set the current column on this line to column @var{x}, with column
230 numbers considered to begin with 1 at the left margin.
231
232 @item @code{NEWREC}@var{x}
233 Skip forward @var{x} lines in the current record, resetting the active
234 column to the left margin.
235
236 @item Repeat count
237 Any format specifier may be preceded by a number.  This causes the
238 action of that format specifier to be repeated the specified number of
239 times.
240
241 @item (@var{spec1}, @dots{}, @var{specN})
242 Group the given specifiers together.  This is most useful when preceded
243 by a repeat count.  Groups may be nested arbitrarily.
244 @end table
245
246 FORTRAN and columnar styles may be freely intermixed.  Columnar style
247 leaves the active column immediately after the ending column
248 specified.  Record motion using @code{NEWREC} in FORTRAN style also
249 applies to later FORTRAN and columnar specifiers.
250  
251 @menu
252 * DATA LIST FIXED Examples::    Examples of DATA LIST FIXED.
253 @end menu
254
255 @node DATA LIST FIXED Examples
256 @unnumberedsubsubsec Examples
257
258 @enumerate
259 @item
260 @example
261 DATA LIST TABLE /NAME 1-10 (A) INFO1 TO INFO3 12-17 (1).
262
263 BEGIN DATA.
264 John Smith 102311
265 Bob Arnold 122015
266 Bill Yates  918 6
267 END DATA.
268 @end example
269
270 Defines the following variables:
271
272 @itemize @bullet
273 @item
274 @code{NAME}, a 10-character-wide long string variable, in columns 1
275 through 10.
276
277 @item
278 @code{INFO1}, a numeric variable, in columns 12 through 13.
279
280 @item
281 @code{INFO2}, a numeric variable, in columns 14 through 15.
282
283 @item
284 @code{INFO3}, a numeric variable, in columns 16 through 17.
285 @end itemize
286
287 The @code{BEGIN DATA}/@code{END DATA} commands cause three cases to be
288 defined:
289
290 @example
291 Case   NAME         INFO1   INFO2   INFO3
292    1   John Smith     10      23      11
293    2   Bob Arnold     12      20      15
294    3   Bill Yates      9      18       6
295 @end example
296
297 The @code{TABLE} keyword causes PSPP to print out a table
298 describing the four variables defined.
299
300 @item
301 @example
302 DAT LIS FIL="survey.dat"
303         /ID 1-5 NAME 7-36 (A) SURNAME 38-67 (A) MINITIAL 69 (A)
304         /Q01 TO Q50 7-56
305         /.
306 @end example
307
308 Defines the following variables:
309
310 @itemize @bullet
311 @item
312 @code{ID}, a numeric variable, in columns 1-5 of the first record.
313
314 @item
315 @code{NAME}, a 30-character long string variable, in columns 7-36 of the
316 first record.
317
318 @item
319 @code{SURNAME}, a 30-character long string variable, in columns 38-67 of
320 the first record.
321
322 @item
323 @code{MINITIAL}, a 1-character short string variable, in column 69 of
324 the first record.
325
326 @item
327 Fifty variables @code{Q01}, @code{Q02}, @code{Q03}, @dots{}, @code{Q49},
328 @code{Q50}, all numeric, @code{Q01} in column 7, @code{Q02} in column 8,
329 @dots{}, @code{Q49} in column 55, @code{Q50} in column 56, all in the second
330 record.
331 @end itemize
332
333 Cases are separated by a blank record.
334
335 Data is read from file @file{survey.dat} in the current directory.
336
337 This example shows keywords abbreviated to their first 3 letters.
338
339 @end enumerate
340
341 @node DATA LIST FREE
342 @subsection DATA LIST FREE
343 @vindex DATA LIST FREE
344
345 @display
346 DATA LIST FREE
347         [(@{TAB,'c'@}, @dots{})]
348         [@{NOTABLE,TABLE@}]
349         FILE='filename'
350         END=end_var
351         /var_spec@dots{}
352
353 where each var_spec takes one of the forms
354         var_list [(type_spec)]
355         var_list *
356 @end display
357
358 In free format, the input data is, by default, structured as a series
359 of fields separated by spaces, tabs, commas, or line breaks.  Each
360 field's content may be unquoted, or it may be quoted with a pairs of
361 apostrophes (@samp{'}) or double quotes (@samp{"}).  Unquoted white
362 space separates fields but is not part of any field.  Any mix of
363 spaces, tabs, and line breaks is equivalent to a single space for the
364 purpose of separating fields, but consecutive commas will skip a
365 field.
366
367 Alternatively, delimiters can be specified explicitly, as a
368 parenthesized, comma-separated list of single-character strings
369 immediately following FREE.  The word TAB may also be used to specify
370 a tab character as a delimiter.  When delimiters are specified
371 explicitly, only the given characters, plus line breaks, separate
372 fields.  Furthermore, leading spaces at the beginnings of fields are
373 not trimmed, consecutive delimiters define empty fields, and no form
374 of quoting is allowed.
375
376 The NOTABLE and TABLE subcommands are as in @cmd{DATA LIST FIXED} above.
377 NOTABLE is the default.
378
379 The FILE and END subcommands are as in @cmd{DATA LIST FIXED} above.
380
381 The variables to be parsed are given as a single list of variable names.
382 This list must be introduced by a single slash (@samp{/}).  The set of
383 variable names may contain format specifications in parentheses
384 (@pxref{Input/Output Formats}).  Format specifications apply to all
385 variables back to the previous parenthesized format specification.  
386
387 In addition, an asterisk may be used to indicate that all variables
388 preceding it are to have input/output format @samp{F8.0}.
389
390 Specified field widths are ignored on input, although all normal limits
391 on field width apply, but they are honored on output.
392
393 @node DATA LIST LIST
394 @subsection DATA LIST LIST
395 @vindex DATA LIST LIST
396
397 @display
398 DATA LIST LIST
399         [(@{TAB,'c'@}, @dots{})]
400         [@{NOTABLE,TABLE@}]
401         FILE='filename'
402         END=end_var
403         /var_spec@dots{}
404
405 where each var_spec takes one of the forms
406         var_list [(type_spec)]
407         var_list *
408 @end display
409
410 With one exception, @cmd{DATA LIST LIST} is syntactically and
411 semantically equivalent to @cmd{DATA LIST FREE}.  The exception is
412 that each input line is expected to correspond to exactly one input
413 record.  If more or fewer fields are found on an input line than
414 expected, an appropriate diagnostic is issued.
415
416 @node END CASE
417 @section END CASE
418 @vindex END CASE
419
420 @display
421 END CASE.
422 @end display
423
424 @cmd{END CASE} is used only within @cmd{INPUT PROGRAM} to output the
425 current case.  @xref{INPUT PROGRAM}, for details.
426
427 @node END FILE
428 @section END FILE
429 @vindex END FILE
430
431 @display
432 END FILE.
433 @end display
434
435 @cmd{END FILE} is used only within @cmd{INPUT PROGRAM} to terminate
436 the current input program.  @xref{INPUT PROGRAM}.
437
438 @node FILE HANDLE
439 @section FILE HANDLE
440 @vindex FILE HANDLE
441
442 @display
443 For text files:
444         FILE HANDLE handle_name
445                 /NAME='filename'
446                 [/MODE=CHARACTER]
447                 /TABWIDTH=tab_width
448
449 For binary files with fixed-length records:
450         FILE HANDLE handle_name
451                 /NAME='filename'
452                 /MODE=IMAGE
453                 [/LRECL=rec_len]
454
455 To explicitly declare a scratch handle:
456         FILE HANDLE handle_name
457                 /MODE=SCRATCH
458 @end display
459
460 Use @cmd{FILE HANDLE} to associate a file handle name with a file and
461 its attributes, so that later commands can refer to the file by its
462 handle name.  Names of text files can be specified directly on
463 commands that access files, so that @cmd{FILE HANDLE} is only needed when a
464 file is not an ordinary file containing lines of text.  However,
465 @cmd{FILE HANDLE} may be used even for text files, and it may be
466 easier to specify a file's name once and later refer to it by an
467 abstract handle.
468
469 Specify the file handle name as the identifier immediately following the
470 @cmd{FILE HANDLE} command name.  The identifier INLINE is reserved for
471 representing data embedded in the syntax file (@pxref{BEGIN DATA}) The
472 file handle name must not already have been used in a previous
473 invocation of @cmd{FILE HANDLE}, unless it has been closed by an
474 intervening command (@pxref{CLOSE FILE HANDLE}).
475
476 MODE specifies a file mode.  In CHARACTER mode, the default, the data
477 file is read as a text file, according to the local system's 
478 conventions, and each text line is read as one record.
479 In CHARACTER mode, most input programs will expand tabs to spaces
480 (@cmd{DATA LIST FREE} with explicitly specified delimiters is an
481 exception).  By default, each tab is 4 characters wide, but an
482 alternate width may be specified on TABWIDTH.  A tab width of 0
483 suppresses tab expansion entirely.
484
485 In IMAGE mode, the data file is opened in ANSI C binary mode and records
486 are fixed in length.  In IMAGE mode, LRECL specifies the record length in
487 bytes, with a default of 1024.  Tab characters are never expanded to
488 spaces in binary mode.
489
490 The NAME subcommand specifies the name of the file associated with the
491 handle.  It is required in CHARACTER and IMAGE modes.
492
493 The SCRATCH mode designates the file handle as a scratch file handle.
494 Its use is usually unnecessary because file handle names that begin with
495 @samp{#} are assumed to refer to scratch files.  @pxref{File Handles},
496 for more information.
497
498 @node INPUT PROGRAM
499 @section INPUT PROGRAM
500 @vindex INPUT PROGRAM
501
502 @display
503 INPUT PROGRAM.
504 @dots{} input commands @dots{}
505 END INPUT PROGRAM.
506 @end display
507
508 @cmd{INPUT PROGRAM}@dots{}@cmd{END INPUT PROGRAM} specifies a
509 complex input program.  By placing data input commands within @cmd{INPUT
510 PROGRAM}, PSPP programs can take advantage of more complex file
511 structures than available with only @cmd{DATA LIST}.
512
513 The first sort of extended input program is to simply put multiple @cmd{DATA
514 LIST} commands within the @cmd{INPUT PROGRAM}.  This will cause all of
515 the data
516 files to be read in parallel.  Input will stop when end of file is
517 reached on any of the data files.
518
519 Transformations, such as conditional and looping constructs, can also be
520 included within @cmd{INPUT PROGRAM}.  These can be used to combine input
521 from several data files in more complex ways.  However, input will still
522 stop when end of file is reached on any of the data files.
523
524 To prevent @cmd{INPUT PROGRAM} from terminating at the first end of
525 file, use
526 the END subcommand on @cmd{DATA LIST}.  This subcommand takes a
527 variable name,
528 which should be a numeric scratch variable (@pxref{Scratch Variables}).
529 (It need not be a scratch variable but otherwise the results can be
530 surprising.)  The value of this variable is set to 0 when reading the
531 data file, or 1 when end of file is encountered.
532
533 Two additional commands are useful in conjunction with @cmd{INPUT PROGRAM}.
534 @cmd{END CASE} is the first.  Normally each loop through the
535 @cmd{INPUT PROGRAM}
536 structure produces one case.  @cmd{END CASE} controls exactly
537 when cases are output.  When @cmd{END CASE} is used, looping from the end of
538 @cmd{INPUT PROGRAM} to the beginning does not cause a case to be output.
539
540 @cmd{END FILE} is the second.  When the END subcommand is used on @cmd{DATA
541 LIST}, there is no way for the @cmd{INPUT PROGRAM} construct to stop
542 looping,
543 so an infinite loop results.  @cmd{END FILE}, when executed,
544 stops the flow of input data and passes out of the @cmd{INPUT PROGRAM}
545 structure.
546
547 All this is very confusing.  A few examples should help to clarify.
548
549 @example
550 INPUT PROGRAM.
551         DATA LIST NOTABLE FILE='a.data'/X 1-10.
552         DATA LIST NOTABLE FILE='b.data'/Y 1-10.
553 END INPUT PROGRAM.
554 LIST.
555 @end example
556
557 The example above reads variable X from file @file{a.data} and variable
558 Y from file @file{b.data}.  If one file is shorter than the other then
559 the extra data in the longer file is ignored.
560
561 @example
562 INPUT PROGRAM.
563         NUMERIC #A #B.
564         
565         DO IF NOT #A.
566                 DATA LIST NOTABLE END=#A FILE='a.data'/X 1-10.
567         END IF.
568         DO IF NOT #B.
569                 DATA LIST NOTABLE END=#B FILE='b.data'/Y 1-10.
570         END IF.
571         DO IF #A AND #B.
572                 END FILE.
573         END IF.
574         END CASE.
575 END INPUT PROGRAM.
576 LIST.
577 @end example
578
579 The above example reads variable X from @file{a.data} and variable Y from
580 @file{b.data}.  If one file is shorter than the other then the missing
581 field is set to the system-missing value alongside the present value for
582 the remaining length of the longer file.
583
584 @example
585 INPUT PROGRAM.
586         NUMERIC #A #B.
587
588         DO IF #A.
589                 DATA LIST NOTABLE END=#B FILE='b.data'/X 1-10.
590                 DO IF #B.
591                         END FILE.
592                 ELSE.
593                         END CASE.
594                 END IF.
595         ELSE.
596                 DATA LIST NOTABLE END=#A FILE='a.data'/X 1-10.
597                 DO IF NOT #A.
598                         END CASE.
599                 END IF.
600         END IF.
601 END INPUT PROGRAM.
602 LIST.
603 @end example
604
605 The above example reads data from file @file{a.data}, then from
606 @file{b.data}, and concatenates them into a single active file.
607
608 @example
609 INPUT PROGRAM.
610         NUMERIC #EOF.
611
612         LOOP IF NOT #EOF.
613                 DATA LIST NOTABLE END=#EOF FILE='a.data'/X 1-10.
614                 DO IF NOT #EOF.
615                         END CASE.
616                 END IF.
617         END LOOP.
618
619         COMPUTE #EOF = 0.
620         LOOP IF NOT #EOF.
621                 DATA LIST NOTABLE END=#EOF FILE='b.data'/X 1-10.
622                 DO IF NOT #EOF.
623                         END CASE.
624                 END IF.
625         END LOOP.
626
627         END FILE.
628 END INPUT PROGRAM.
629 LIST.
630 @end example
631
632 The above example does the same thing as the previous example, in a
633 different way.
634
635 @example
636 INPUT PROGRAM.
637         LOOP #I=1 TO 50.
638                 COMPUTE X=UNIFORM(10).
639                 END CASE.
640         END LOOP.
641         END FILE.
642 END INPUT PROGRAM.
643 LIST/FORMAT=NUMBERED.
644 @end example
645
646 The above example causes an active file to be created consisting of 50
647 random variates between 0 and 10.
648
649 @node LIST
650 @section LIST
651 @vindex LIST
652
653 @display
654 LIST
655         /VARIABLES=var_list
656         /CASES=FROM start_index TO end_index BY incr_index
657         /FORMAT=@{UNNUMBERED,NUMBERED@} @{WRAP,SINGLE@} 
658                 @{NOWEIGHT,WEIGHT@}
659 @end display
660
661 The @cmd{LIST} procedure prints the values of specified variables to the
662 listing file.
663
664 The VARIABLES subcommand specifies the variables whose values are to be
665 printed.  Keyword VARIABLES is optional.  If VARIABLES subcommand is not
666 specified then all variables in the active file are printed.
667
668 The CASES subcommand can be used to specify a subset of cases to be
669 printed.  Specify FROM and the case number of the first case to print,
670 TO and the case number of the last case to print, and BY and the number
671 of cases to advance between printing cases, or any subset of those
672 settings.  If CASES is not specified then all cases are printed.
673
674 The FORMAT subcommand can be used to change the output format.  NUMBERED
675 will print case numbers along with each case; UNNUMBERED, the default,
676 causes the case numbers to be omitted.  The WRAP and SINGLE settings are
677 currently not used.  WEIGHT will cause case weights to be printed along
678 with variable values; NOWEIGHT, the default, causes case weights to be
679 omitted from the output.
680
681 Case numbers start from 1.  They are counted after all transformations
682 have been considered.
683
684 @cmd{LIST} attempts to fit all the values on a single line.  If needed
685 to make them fit, variable names are displayed vertically.  If values
686 cannot fit on a single line, then a multi-line format will be used.
687
688 @cmd{LIST} is a procedure.  It causes the data to be read.
689
690 @node MATRIX DATA
691 @section MATRIX DATA
692 @vindex MATRIX DATA
693
694 @display
695 MATRIX DATA
696         /VARIABLES=var_list
697         /FILE='filename'
698         /FORMAT=@{LIST,FREE@} @{LOWER,UPPER,FULL@} @{DIAGONAL,NODIAGONAL@}
699         /SPLIT=@{new_var,var_list@}
700         /FACTORS=var_list
701         /CELLS=n_cells
702         /N=n
703         /CONTENTS=@{N_VECTOR,N_SCALAR,N_MATRIX,MEAN,STDDEV,COUNT,MSE,
704                    DFE,MAT,COV,CORR,PROX@}
705 @end display
706
707 @cmd{MATRIX DATA} command reads square matrices in one of several textual
708 formats.  @cmd{MATRIX DATA} clears the dictionary and replaces it and
709 reads a
710 data file.
711
712 Use VARIABLES to specify the variables that form the rows and columns of
713 the matrices.  You may not specify a variable named @code{VARNAME_}.  You
714 should specify VARIABLES first.
715
716 Specify the file to read on FILE, either as a file name string or a file
717 handle (@pxref{File Handles}).  If FILE is not specified then matrix data
718 must immediately follow @cmd{MATRIX DATA} with a @cmd{BEGIN
719 DATA}@dots{}@cmd{END DATA}
720 construct (@pxref{BEGIN DATA}).
721
722 The FORMAT subcommand specifies how the matrices are formatted.  LIST,
723 the default, indicates that there is one line per row of matrix data;
724 FREE allows single matrix rows to be broken across multiple lines.  This
725 is analogous to the difference between @cmd{DATA LIST FREE} and
726 @cmd{DATA LIST LIST}
727 (@pxref{DATA LIST}).  LOWER, the default, indicates that the lower
728 triangle of the matrix is given; UPPER indicates the upper triangle; and
729 FULL indicates that the entire matrix is given.  DIAGONAL, the default,
730 indicates that the diagonal is part of the data; NODIAGONAL indicates
731 that it is omitted.  DIAGONAL/NODIAGONAL have no effect when FULL is
732 specified.
733
734 The SPLIT subcommand is used to specify @cmd{SPLIT FILE} variables for the
735 input matrices (@pxref{SPLIT FILE}).  Specify either a single variable
736 not specified on VARIABLES, or one or more variables that are specified
737 on VARIABLES.  In the former case, the SPLIT values are not present in
738 the data and ROWTYPE_ may not be specified on VARIABLES.  In the latter
739 case, the SPLIT values are present in the data.
740
741 Specify a list of factor variables on FACTORS.  Factor variables must
742 also be listed on VARIABLES.  Factor variables are used when there are
743 some variables where, for each possible combination of their values,
744 statistics on the matrix variables are included in the data.
745
746 If FACTORS is specified and ROWTYPE_ is not specified on VARIABLES, the
747 CELLS subcommand is required.  Specify the number of factor variable
748 combinations that are given.  For instance, if factor variable A has 2
749 values and factor variable B has 3 values, specify 6.
750
751 The N subcommand specifies a population number of observations.  When N
752 is specified, one N record is output for each @cmd{SPLIT FILE}.
753
754 Use CONTENTS to specify what sort of information the matrices include.
755 Each possible option is described in more detail below.  When ROWTYPE_
756 is specified on VARIABLES, CONTENTS is optional; otherwise, if CONTENTS
757 is not specified then /CONTENTS=CORR is assumed.
758
759 @table @asis
760 @item N
761 @item N_VECTOR
762 Number of observations as a vector, one value for each variable.
763 @item N_SCALAR
764 Number of observations as a single value.
765 @item N_MATRIX
766 Matrix of counts.
767 @item MEAN
768 Vector of means.
769 @item STDDEV
770 Vector of standard deviations.
771 @item COUNT
772 Vector of counts.
773 @item MSE
774 Vector of mean squared errors.
775 @item DFE
776 Vector of degrees of freedom.
777 @item MAT
778 Generic matrix.
779 @item COV
780 Covariance matrix.
781 @item CORR
782 Correlation matrix.
783 @item PROX
784 Proximities matrix.
785 @end table
786
787 The exact semantics of the matrices read by @cmd{MATRIX DATA} are complex.
788 Right now @cmd{MATRIX DATA} isn't too useful due to a lack of procedures
789 accepting or producing related data, so these semantics aren't
790 documented.  Later, they'll be described here in detail.
791
792 @node NEW FILE
793 @section NEW FILE
794 @vindex NEW FILE
795
796 @display
797 NEW FILE.
798 @end display
799
800 @cmd{NEW FILE} command clears the current active file.
801
802 @node PRINT
803 @section PRINT
804 @vindex PRINT
805
806 @display
807 PRINT 
808         OUTFILE='filename'
809         RECORDS=n_lines
810         @{NOTABLE,TABLE@}
811         /[line_no] arg@dots{}
812
813 arg takes one of the following forms:
814         'string' [start-end]
815         var_list start-end [type_spec]
816         var_list (fortran_spec)
817         var_list *
818 @end display
819
820 The @cmd{PRINT} transformation writes variable data to an output file.
821 @cmd{PRINT} is executed when a procedure causes the data to be read.
822 Follow @cmd{PRINT} by @cmd{EXECUTE} to print variable data without
823 invoking a procedure (@pxref{EXECUTE}).
824
825 All @cmd{PRINT} subcommands are optional.
826
827 The OUTFILE subcommand specifies the file to receive the output.  The
828 file may be a file name as a string or a file handle (@pxref{File
829 Handles}).  If OUTFILE is not present then output will be sent to PSPP's
830 output listing file.
831
832 The RECORDS subcommand specifies the number of lines to be output.  The
833 number of lines may optionally be surrounded by parentheses.
834
835 TABLE will cause the PRINT command to output a table to the listing file
836 that describes what it will print to the output file.  NOTABLE, the
837 default, suppresses this output table.
838
839 Introduce the strings and variables to be printed with a slash
840 (@samp{/}).  Optionally, the slash may be followed by a number
841 indicating which output line will be specified.  In the absence of this
842 line number, the next line number will be specified.  Multiple lines may
843 be specified using multiple slashes with the intended output for a line
844 following its respective slash.
845
846 Literal strings may be printed.  Specify the string itself.  Optionally
847 the string may be followed by a column number or range of column
848 numbers, specifying the location on the line for the string to be
849 printed.  Otherwise, the string will be printed at the current position
850 on the line.
851
852 Variables to be printed can be specified in the same ways as available
853 for @cmd{DATA LIST FIXED} (@pxref{DATA LIST FIXED}).  In addition, a
854 variable
855 list may be followed by an asterisk (@samp{*}), which indicates that the
856 variables should be printed in their dictionary print formats, separated
857 by spaces.  A variable list followed by a slash or the end of command
858 will be interpreted the same way.
859
860 If a FORTRAN type specification is used to move backwards on the current
861 line, then text is written at that point on the line, the line will be
862 truncated to that length, although additional text being added will
863 again extend the line to that length.
864
865 @node PRINT EJECT
866 @section PRINT EJECT
867 @vindex PRINT EJECT
868
869 @display
870 PRINT EJECT 
871         OUTFILE='filename'
872         RECORDS=n_lines
873         @{NOTABLE,TABLE@}
874         /[line_no] arg@dots{}
875
876 arg takes one of the following forms:
877         'string' [start-end]
878         var_list start-end [type_spec]
879         var_list (fortran_spec)
880         var_list *
881 @end display
882
883 @cmd{PRINT EJECT} writes data to an output file.  Before the data is
884 written, the current page in the listing file is ejected.
885
886 @xref{PRINT}, for more information on syntax and usage.
887
888 @node PRINT SPACE
889 @section PRINT SPACE
890 @vindex PRINT SPACE
891
892 @display
893 PRINT SPACE OUTFILE='filename' n_lines.
894 @end display
895
896 @cmd{PRINT SPACE} prints one or more blank lines to an output file.
897
898 The OUTFILE subcommand is optional.  It may be used to direct output to
899 a file specified by file name as a string or file handle (@pxref{File
900 Handles}).  If OUTFILE is not specified then output will be directed to
901 the listing file.
902
903 n_lines is also optional.  If present, it is an expression
904 (@pxref{Expressions}) specifying the number of blank lines to be
905 printed.  The expression must evaluate to a nonnegative value.
906
907 @node REREAD
908 @section REREAD
909 @vindex REREAD
910
911 @display
912 REREAD FILE=handle COLUMN=column.
913 @end display
914
915 The @cmd{REREAD} transformation allows the previous input line in a
916 data file
917 already processed by @cmd{DATA LIST} or another input command to be re-read
918 for further processing.
919
920 The FILE subcommand, which is optional, is used to specify the file to
921 have its line re-read.  The file must be specified as the name of a file
922 handle (@pxref{File Handles}).  If FILE is not specified then the last
923 file specified on @cmd{DATA LIST} will be assumed (last file specified
924 lexically, not in terms of flow-of-control).
925
926 By default, the line re-read is re-read in its entirety.  With the
927 COLUMN subcommand, a prefix of the line can be exempted from
928 re-reading.  Specify an expression (@pxref{Expressions}) evaluating to
929 the first column that should be included in the re-read line.  Columns
930 are numbered from 1 at the left margin.
931
932 Issuing @code{REREAD} multiple times will not back up in the data
933 file.  Instead, it will re-read the same line multiple times.
934
935 @node REPEATING DATA
936 @section REPEATING DATA
937 @vindex REPEATING DATA
938
939 @display
940 REPEATING DATA
941         /STARTS=start-end
942         /OCCURS=n_occurs
943         /FILE='filename'
944         /LENGTH=length
945         /CONTINUED[=cont_start-cont_end]
946         /ID=id_start-id_end=id_var
947         /@{TABLE,NOTABLE@}
948         /DATA=var_spec@dots{}
949
950 where each var_spec takes one of the forms
951         var_list start-end [type_spec]
952         var_list (fortran_spec)
953 @end display
954
955 @cmd{REPEATING DATA} parses groups of data repeating in
956 a uniform format, possibly with several groups on a single line.  Each
957 group of data corresponds with one case.  @cmd{REPEATING DATA} may only be
958 used within an @cmd{INPUT PROGRAM} structure (@pxref{INPUT PROGRAM}).
959 When used with @cmd{DATA LIST}, it
960 can be used to parse groups of cases that share a subset of variables
961 but differ in their other data.
962
963 The STARTS subcommand is required.  Specify a range of columns, using
964 literal numbers or numeric variable names.  This range specifies the
965 columns on the first line that are used to contain groups of data.  The
966 ending column is optional.  If it is not specified, then the record
967 width of the input file is used.  For the inline file (@pxref{BEGIN
968 DATA}) this is 80 columns; for a file with fixed record widths it is the
969 record width; for other files it is 1024 characters by default.
970
971 The OCCURS subcommand is required.  It must be a number or the name of a
972 numeric variable.  Its value is the number of groups present in the
973 current record.
974
975 The DATA subcommand is required.  It must be the last subcommand
976 specified.  It is used to specify the data present within each repeating
977 group.  Column numbers are specified relative to the beginning of a
978 group at column 1.  Data is specified in the same way as with @cmd{DATA LIST
979 FIXED} (@pxref{DATA LIST FIXED}).
980
981 All other subcommands are optional.
982
983 FILE specifies the file to read, either a file name as a string or a
984 file handle (@pxref{File Handles}).  If FILE is not present then the
985 default is the last file handle used on @cmd{DATA LIST} (lexically, not in
986 terms of flow of control).
987
988 By default @cmd{REPEATING DATA} will output a table describing how it will
989 parse the input data.  Specifying NOTABLE will disable this behavior;
990 specifying TABLE will explicitly enable it.
991
992 The LENGTH subcommand specifies the length in characters of each group.
993 If it is not present then length is inferred from the DATA subcommand.
994 LENGTH can be a number or a variable name.
995
996 Normally all the data groups are expected to be present on a single
997 line.  Use the CONTINUED command to indicate that data can be continued
998 onto additional lines.  If data on continuation lines starts at the left
999 margin and continues through the entire field width, no column
1000 specifications are necessary on CONTINUED.  Otherwise, specify the
1001 possible range of columns in the same way as on STARTS.
1002
1003 When data groups are continued from line to line, it is easy
1004 for cases to get out of sync through careless hand editing.  The
1005 ID subcommand allows a case identifier to be present on each line of
1006 repeating data groups.  @cmd{REPEATING DATA} will check for the same
1007 identifier on each line and report mismatches.  Specify the range of
1008 columns that the identifier will occupy, followed by an equals sign
1009 (@samp{=}) and the identifier variable name.  The variable must already
1010 have been declared with @cmd{NUMERIC} or another command.
1011
1012 @cmd{REPEATING DATA} should be the last command given within an
1013 @cmd{INPUT PROGRAM}.  It should not be enclosed within a @cmd{LOOP}
1014 structure (@pxref{LOOP}).  Use @cmd{DATA LIST} before, not after,
1015 @cmd{REPEATING DATA}.
1016
1017 @node WRITE
1018 @section WRITE
1019 @vindex WRITE
1020
1021 @display
1022 WRITE 
1023         OUTFILE='filename'
1024         RECORDS=n_lines
1025         @{NOTABLE,TABLE@}
1026         /[line_no] arg@dots{}
1027
1028 arg takes one of the following forms:
1029         'string' [start-end]
1030         var_list start-end [type_spec]
1031         var_list (fortran_spec)
1032         var_list *
1033 @end display
1034
1035 @code{WRITE} writes text or binary data to an output file.  
1036
1037 @xref{PRINT}, for more information on syntax and usage.  The main
1038 difference between @code{PRINT} and @code{WRITE} is that @cmd{WRITE}
1039 uses write formats by default, where PRINT uses print formats.
1040
1041 The sole additional difference is that if @cmd{WRITE} is used to send output
1042 to a binary file, carriage control characters will not be output.
1043 @xref{FILE HANDLE}, for information on how to declare a file as binary.
1044 @setfilename ignored