@display
Per input file:
- /FILE=@{*,'file-name'@}
- [/RENAME=(src_names=target_names)@dots{}]
- [/IN=var_name]
+ /FILE=@{*,'@var{file_name}'@}
+ [/RENAME=(@var{src_names}=@var{target_names})@dots{}]
+ [/IN=@var{var_name}]
[/SORT]
Once per command:
- /BY var_list[(@{D|A@})] [var_list[(@{D|A@}]]@dots{}
- [/DROP=var_list]
- [/KEEP=var_list]
- [/FIRST=var_name]
- [/LAST=var_name]
+ /BY @var{var_list}[(@{D|A@})] [@var{var_list}[(@{D|A@}]]@dots{}
+ [/DROP=@var{var_list}]
+ [/KEEP=@var{var_list}]
+ [/FIRST=@var{var_name}]
+ [/LAST=@var{var_name}]
[/MAP]
@end display
Each @subcmd{FILE} subcommand may be followed by any number of @subcmd{RENAME}
subcommands that specify a parenthesized group or groups of variable
names as they appear in the input file, followed by those variables'
-new names, separated by an equals sign (@samp{=}),
-e.g. @samp{/RENAME=(OLD1=NEW1)(OLD2=NEW2)}. To rename a single
-variable, the parentheses may be omitted: @samp{/RENAME=OLD=NEW}.
+new names, separated by an equals sign (@subcmd{=}),
+e.g. @subcmd{/RENAME=(OLD1=NEW1)(OLD2=NEW2)}. To rename a single
+variable, the parentheses may be omitted: @subcmd{/RENAME=@var{old}=@var{new}}.
Within a parenthesized group, variables are renamed simultaneously, so
-that @samp{/RENAME=(A B=B A)} exchanges the names of variables A and
-B. Otherwise, renaming occurs in left-to-right order.
+that @subcmd{/RENAME=(@var{A} @var{B}=@var{B} @var{A})} exchanges the
+names of variables @var{A} and @var{B}.
+Otherwise, renaming occurs in left-to-right order.
Each @subcmd{FILE} subcommand may optionally be followed by a single @subcmd{IN}
subcommand, which creates a numeric variable with the specified name
the given input file contributed to that output case, and 0 otherwise.
The @subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} subcommands have no effect on IN variables.
-If BY is used (see below), the SORT keyword must be specified after a
-@subcmd{FILE} if that input file is not already sorted on the BY variables.
-When @subcmd{SORT} is specified, @pspp{} sorts the input file's data on the BY
-variables before it applies it to the command. When SORT is used, BY
+If @subcmd{BY} is used (see below), the @subcmd{SORT} keyword must be specified after a
+@subcmd{FILE} if that input file is not already sorted on the @subcmd{BY} variables.
+When @subcmd{SORT} is specified, @pspp{} sorts the input file's data on the @subcmd{BY}
+variables before it applies it to the command. When @subcmd{SORT} is used, @subcmd{BY}
is required. @subcmd{SORT} is a @pspp{} extension.
@pspp{} merges the dictionaries of all of the input files to form the
The remaining subcommands apply to the output file as a whole, rather
than to individual input files. They must be specified at the end of
the command specification, following all of the FILE and related
-subcommands. The most important of these subcommands is BY, which
+subcommands. The most important of these subcommands is @subcmd{BY}, which
specifies a set of one or more variables that may be used to find
corresponding cases in each of the input files. The variables
-specified on BY must be present in all of the input files.
-Furthermore, if any of the input files are not sorted on the BY
-variables, then SORT must be specified for those input files.
+specified on @subcmd{BY} must be present in all of the input files.
+Furthermore, if any of the input files are not sorted on the @subcmd{BY}
+variables, then @subcmd{SORT} must be specified for those input files.
-The variables listed on BY may include (A) or (D) annotations to
+The variables listed on @subcmd{BY} may include (A) or (D) annotations to
specify ascending or descending sort order. @xref{SORT CASES}, for
more details on this notation. Adding (A) or (D) to the @subcmd{BY} subcommand
specification is a @pspp{} extension.
The @subcmd{DROP} subcommand can be used to specify a list of variables to
exclude from the output. By contrast, the @subcmd{KEEP} subcommand can be used
to specify variables to include in the output; all variables not
-listed are dropped. DROP and KEEP are executed in left-to-right order
-and may be repeated any number of times. DROP and KEEP do not affect
-variables created by the IN, FIRST, and @subcmd{LAST} subcommands, which are
+listed are dropped. @subcmd{DROP} and @subcmd{KEEP} are executed in left-to-right order
+and may be repeated any number of times. @subcmd{DROP} and @subcmd{KEEP} do not affect
+variables created by the @subcmd{IN}, @subcmd{FIRST}, and @subcmd{LAST} subcommands, which are
always included in the new active dataset, but they can be used to drop
-BY variables.
+@subcmd{BY} variables.
The @subcmd{FIRST} and @subcmd{LAST} subcommands are optional. They may only be
-specified on @cmd{MATCH FILES} and @cmd{ADD FILES}, and only when BY
+specified on @cmd{MATCH FILES} and @cmd{ADD FILES}, and only when @subcmd{BY}
is used. @subcmd{FIRST} and @subcmd{LIST} each adds a numeric variable to the new
active dataset, with the name given as the subcommand's argument and F1.0
print and write formats. The value of the @subcmd{FIRST} variable is 1 in the
-first output case with a given set of values for the BY variables, and
+first output case with a given set of values for the @subcmd{BY} variables, and
0 in other cases. Similarly, the @subcmd{LAST} variable is 1 in the last case
with a given of @subcmd{BY} values, and 0 in other cases.
ADD FILES
Per input file:
- /FILE=@{*,'file-name'@}
- [/RENAME=(src_names=target_names)@dots{}]
- [/IN=var_name]
+ /FILE=@{*,'@var{file_name}'@}
+ [/RENAME=(@var{src_names}=@var{target_names})@dots{}]
+ [/IN=@var{var_name}]
[/SORT]
Once per command:
- [/BY var_list[(@{D|A@})] [var_list[(@{D|A@})]@dots{}]]
- [/DROP=var_list]
- [/KEEP=var_list]
- [/FIRST=var_name]
- [/LAST=var_name]
+ [/BY @var{var_list}[(@{D|A@})] [@var{var_list}[(@{D|A@})]@dots{}]]
+ [/DROP=@var{var_list}]
+ [/KEEP=@var{var_list}]
+ [/FIRST=@var{var_name}]
+ [/LAST=@var{var_name}]
[/MAP]
@end display
When @subcmd{BY} is not used, the output of @subcmd{ADD FILES} consists of all the cases
from the first input file specified, followed by all the cases from
-the second file specified, and so on. When BY is used, the output is
-additionally sorted on the BY variables.
+the second file specified, and so on. When @subcmd{BY} is used, the output is
+additionally sorted on the @subcmd{BY} variables.
When @subcmd{ADD FILES} creates an output case, variables that are not part of
the input file from which the case was drawn are set to the
MATCH FILES
Per input file:
- /@{FILE,TABLE@}=@{*,'file-name'@}
- [/RENAME=(src_names=target_names)@dots{}]
- [/IN=var_name]
+ /@{FILE,TABLE@}=@{*,'@var{file_name}'@}
+ [/RENAME=(@var{src_names}=@var{target_names})@dots{}]
+ [/IN=@var{var_name}]
[/SORT]
Once per command:
- /BY var_list[(@{D|A@}] [var_list[(@{D|A@})]@dots{}]
- [/DROP=var_list]
- [/KEEP=var_list]
- [/FIRST=var_name]
- [/LAST=var_name]
+ /BY @var{var_list}[(@{D|A@}] [@var{var_list}[(@{D|A@})]@dots{}]
+ [/DROP=@var{var_list}]
+ [/KEEP=@var{var_list}]
+ [/FIRST=@var{var_name}]
+ [/LAST=@var{var_name}]
[/MAP]
@end display
@cmd{MATCH FILES} merges sets of corresponding cases in multiple
input files into single cases in the output, combining their data.
-MATCH FILES shares the bulk of its syntax with other @pspp{} commands for
+@cmd{MATCH FILES} shares the bulk of its syntax with other @pspp{} commands for
combining multiple data files. @xref{Combining Files Common Syntax},
above, for an explanation of this common syntax.
-How MATCH FILES matches up cases from the input files depends on
-whether BY is specified:
+How @cmd{MATCH FILES} matches up cases from the input files depends on
+whether @subcmd{BY} is specified:
@itemize @bullet
@item
-If BY is not used, MATCH FILES combines the first case from each input
+If @subcmd{BY} is not used, @cmd{MATCH FILES} combines the first case from each input
file to produce the first output case, then the second case from each
input file for the second output case, and so on. If some input files
have fewer cases than others, then the shorter files do not contribute
to cases output after their input has been exhausted.
@item
-If BY is used, MATCH FILES combines cases from each input file that
+If @subcmd{BY} is used, @cmd{MATCH FILES} combines cases from each input file that
have identical values for the BY variables.
-When BY is used, @subcmd{TABLE} subcommands may be used to introduce @dfn{table
+When @subcmd{BY} is used, @subcmd{TABLE} subcommands may be used to introduce @dfn{table
lookup file}. @subcmd{TABLE} has same syntax as @subcmd{FILE}, and the @subcmd{RENAME}, @subcmd{IN}, and
-@subcmd{SORT} subcommands may follow a TABLE in the same way as a FILE.
-Regardless of the number of TABLEs, at least one FILE must specified.
+@subcmd{SORT} subcommands may follow a @subcmd{TABLE} in the same way as @subcmd{FILE}.
+Regardless of the number of @subcmd{TABLE}s, at least one @subcmd{FILE} must specified.
Table lookup files are treated in the same way as other input files
for most purposes and, in particular, table lookup files must be
-sorted on the BY variables or the @subcmd{SORT} subcommand must be specified
-for that TABLE.
+sorted on the @subcmd{BY} variables or the @subcmd{SORT} subcommand must be specified
+for that @subcmd{TABLE}.
Cases in table lookup files are not consumed after they have been used
once. This means that data in table lookup files can correspond to
-any number of cases in FILE input files. Table lookup files are
+any number of cases in @subcmd{FILE} input files. Table lookup files are
analogous to lookup tables in traditional relational database systems.
If a table lookup file contains more than one case with a given set of
-BY variables, only the first case is used.
+@subcmd{BY} variables, only the first case is used.
@end itemize
-When MATCH FILES creates an output case, variables that are only in
+When @cmd{MATCH FILES} creates an output case, variables that are only in
files that are not present for the current case are set to the
system-missing value for numeric variables or spaces for string
variables.
UPDATE
Per input file:
- /FILE=@{*,'file-name'@}
- [/RENAME=(src_names=target_names)@dots{}]
- [/IN=var_name]
+ /FILE=@{*,'@var{file_name}'@}
+ [/RENAME=(@var{src_names}=@var{target_names})@dots{}]
+ [/IN=@var{var_name}]
[/SORT]
Once per command:
- /BY var_list[(@{D|A@})] [var_list[(@{D|A@})]]@dots{}
- [/DROP=var_list]
- [/KEEP=var_list]
+ /BY @var{var_list}[(@{D|A@})] [@var{var_list}[(@{D|A@})]]@dots{}
+ [/DROP=@var{var_list}]
+ [/KEEP=@var{var_list}]
[/MAP]
@end display
file. If there are matching cases in more than more transaction file,
@pspp{} applies the replacements from the first transaction file, then
from the second transaction file, and so on. Similarly, if a single
-transaction file has cases with duplicate BY values, then those are
+transaction file has cases with duplicate @subcmd{BY} values, then those are
applied in order to the master file.
When a variable in a transaction file has a missing value or a string
+@c (modify-syntax-entry ?_ "w")
+@c (modify-syntax-entry ?' "'")
+@c (modify-syntax-entry ?@ "'")
+
+
@node Data Input and Output
@chapter Data Input and Output
@cindex input
@section CLOSE FILE HANDLE
@display
-CLOSE FILE HANDLE handle_name.
+CLOSE FILE HANDLE @var{handle_name}.
@end display
@cmd{CLOSE FILE HANDLE} disassociates the name of a file handle with a
@display
DATAFILE ATTRIBUTE
- ATTRIBUTE=name('value') [name('value')]@dots{}
- ATTRIBUTE=name@b{[}index@b{]}('value') [name@b{[}index@b{]}('value')]@dots{}
- DELETE=name [name]@dots{}
- DELETE=name@b{[}index@b{]} [name@b{[}index@b{]}]@dots{}
+ ATTRIBUTE=@var{name}('@var{value}') [@var{name}('@var{value}')]@dots{}
+ ATTRIBUTE=@var{name}@b{[}@var{index}@b{]}('@var{value}') [@var{name}@b{[}@var{index}@b{]}('@var{value}')]@dots{}
+ DELETE=@var{name} [@var{name}]@dots{}
+ DELETE=@var{name}@b{[}@var{index}@b{]} [@var{name}@b{[}@var{index}@b{]}]@dots{}
@end display
@cmd{DATAFILE ATTRIBUTE} adds, modifies, or removes user-defined
@vindex DATASET
@display
-DATASET NAME name [WINDOW=@{ASIS,FRONT@}].
-DATASET ACTIVATE name [WINDOW=@{ASIS,FRONT@}].
-DATASET COPY name [WINDOW=@{MINIMIZED,HIDDEN,FRONT@}].
-DATASET DECLARE name [WINDOW=@{MINIMIZED,HIDDEN,FRONT@}].
-DATASET CLOSE @{name,*,ALL@}.
+DATASET NAME @var{name} [WINDOW=@{ASIS,FRONT@}].
+DATASET ACTIVATE @var{name} [WINDOW=@{ASIS,FRONT@}].
+DATASET COPY @var{name} [WINDOW=@{MINIMIZED,HIDDEN,FRONT@}].
+DATASET DECLARE @var{name} [WINDOW=@{MINIMIZED,HIDDEN,FRONT@}].
+DATASET CLOSE @{@var{name},*,ALL@}.
DATASET DISPLAY.
@end display
@display
DATA LIST [FIXED]
@{TABLE,NOTABLE@}
- [FILE='file-name' [ENCODING='encoding']]
- [RECORDS=record_count]
- [END=end_var]
- [SKIP=record_count]
- /[line_no] var_spec@dots{}
-
-where each var_spec takes one of the forms
- var_list start-end [type_spec]
- var_list (fortran_spec)
+ [FILE='@var{file_name}' [ENCODING='@var{encoding}']]
+ [RECORDS=@var{record_count}]
+ [END=@var{end_var}]
+ [SKIP=@var{record_count}]
+ /[line_no] @var{var_spec}@dots{}
+
+where each @var{var_spec} takes one of the forms
+ @var{var_list} @var{start}-@var{end} [@var{type_spec}]
+ @var{var_list} (@var{fortran_spec})
@end display
@cmd{DATA LIST FIXED} is used to read data files that have values at fixed
It specifies the character encoding of the file.
The optional @subcmd{RECORDS} subcommand, which takes a single integer as an
-argument, is used to specify the number of lines per record. If RECORDS
+argument, is used to specify the number of lines per record.
+If @subcmd{RECORDS}
is not specified, then the number of lines per record is calculated from
the list of variable specifications later in @cmd{DATA LIST}.
that contains variable names, for example.
@cmd{DATA LIST} can optionally output a table describing how the data file
-will be read. The @subcmd{TABLE} subcommand enables this output, and @subcmd{NOTABLE}
-disables it. The default is to output the table.
+will be read. The @subcmd{TABLE} subcommand enables this output, and
+@subcmd{NOTABLE} disables it. The default is to output the table.
The list of variables to be read from the data list must come last.
Each line in the data record is introduced by a slash (@samp{/}).
@display
DATA LIST FREE
- [(@{TAB,'c'@}, @dots{})]
+ [(@{TAB,'@var{c}'@}, @dots{})]
[@{NOTABLE,TABLE@}]
- [FILE='file-name' [ENCODING='encoding']]
- [SKIP=record_cnt]
- /var_spec@dots{}
+ [FILE='@var{file_name}' [ENCODING='@var{encoding}']]
+ [SKIP=@var{record_cnt}]
+ /@var{var_spec}@dots{}
-where each var_spec takes one of the forms
- var_list [(type_spec)]
- var_list *
+where each @var{var_spec} takes one of the forms
+ @var{var_list} [(@var{type_spec})]
+ @var{var_list} *
@end display
In free format, the input data is, by default, structured as a series
@display
DATA LIST LIST
- [(@{TAB,'c'@}, @dots{})]
+ [(@{TAB,'@var{c}'@}, @dots{})]
[@{NOTABLE,TABLE@}]
- [FILE='file-name' [ENCODING='encoding']]
- [SKIP=record_count]
- /var_spec@dots{}
+ [FILE='@var{file_name'} [ENCODING='@var{encoding}']]
+ [SKIP=@var{record_count}]
+ /@var{var_spec}@dots{}
-where each var_spec takes one of the forms
- var_list [(type_spec)]
- var_list *
+where each @var{var_spec} takes one of the forms
+ @var{var_list} [(@var{type_spec})]
+ @var{var_list} *
@end display
With one exception, @cmd{DATA LIST LIST} is syntactically and
@display
For text files:
- FILE HANDLE handle_name
- /NAME='file-name'
+ FILE HANDLE @var{handle_name}
+ /NAME='@var{file_name}
[/MODE=CHARACTER]
- /TABWIDTH=tab_width
+ /TABWIDTH=@var{tab_width}
For binary files in native encoding with fixed-length records:
- FILE HANDLE handle_name
- /NAME='file-name'
+ FILE HANDLE @var{handle_name}
+ /NAME='@var{file_name}'
/MODE=IMAGE
- [/LRECL=rec_len]
+ [/LRECL=@var{rec_len}]
For binary files in native encoding with variable-length records:
- FILE HANDLE handle_name
- /NAME='file-name'
+ FILE HANDLE @var{handle_name}
+ /NAME='@var{file_name}'
/MODE=BINARY
- [/LRECL=rec_len]
+ [/LRECL=@var{rec_len}]
For binary files encoded in EBCDIC:
- FILE HANDLE handle_name
- /NAME='file-name'
+ FILE HANDLE @var{handle_name}
+ /NAME='@var{file_name}'
/MODE=360
/RECFORM=@{FIXED,VARIABLE,SPANNED@}
- [/LRECL=rec_len]
+ [/LRECL=@var{rec_len}]
@end display
Use @cmd{FILE HANDLE} to associate a file handle name with a file and
invocation of @cmd{FILE HANDLE}, unless it has been closed by an
intervening command (@pxref{CLOSE FILE HANDLE}).
-The effect and syntax of FILE HANDLE depends on the selected MODE:
+The effect and syntax of @cmd{FILE HANDLE} depends on the selected MODE:
@itemize
@item
@display
LIST
- /VARIABLES=var_list
- /CASES=FROM start_index TO end_index BY incr_index
+ /VARIABLES=@var{var_list}
+ /CASES=FROM @var{start_index} TO @var{end_index} BY @var{incr_index}
/FORMAT=@{UNNUMBERED,NUMBERED@} @{WRAP,SINGLE@}
@end display
@display
PRINT
- OUTFILE='file-name'
- RECORDS=n_lines
+ OUTFILE='@var{file_name}'
+ RECORDS=@var{n_lines}
@{NOTABLE,TABLE@}
- [/[line_no] arg@dots{}]
+ [/[@var{line_no}] @var{arg}@dots{}]
-arg takes one of the following forms:
- 'string' [start-end]
- var_list start-end [type_spec]
- var_list (fortran_spec)
- var_list *
+@var{arg} takes one of the following forms:
+ '@var{string}' [@var{start}-@var{end}]
+ @var{var_list} @var{start}-@var{end} [@var{type_spec}]
+ @var{var_list} (@var{fortran_spec})
+ @var{var_list} *
@end display
The @cmd{PRINT} transformation writes variable data to the listing
print variable data without invoking a procedure (@pxref{EXECUTE}).
All @cmd{PRINT} subcommands are optional. If no strings or variables
-are specified, PRINT outputs a single blank line.
+are specified, @cmd{PRINT} outputs a single blank line.
The @subcmd{OUTFILE} subcommand specifies the file to receive the output. The
file may be a file name as a string or a file handle (@pxref{File
-Handles}). If OUTFILE is not present then output will be sent to
-@pspp{}'s output listing file. When OUTFILE is present, a space is
+Handles}). If @subcmd{OUTFILE} is not present then output will be sent to
+@pspp{}'s output listing file. When @subcmd{OUTFILE} is present, a space is
inserted at beginning of each output line, even lines that otherwise
would be blank.
be specified using multiple slashes with the intended output for a line
following its respective slash.
+
Literal strings may be printed. Specify the string itself. Optionally
the string may be followed by a column number or range of column
numbers, specifying the location on the line for the string to be
@display
PRINT EJECT
- OUTFILE='file-name'
- RECORDS=n_lines
+ OUTFILE='@var{file_name}'
+ RECORDS=@var{n_lines}
@{NOTABLE,TABLE@}
- /[line_no] arg@dots{}
+ /[@var{line_no}] @var{arg}@dots{}
-arg takes one of the following forms:
- 'string' [start-end]
- var_list start-end [type_spec]
- var_list (fortran_spec)
- var_list *
+@var{arg} takes one of the following forms:
+ '@var{string}' [@var{start}-@var{end}]
+ @var{var_list} @var{start}-@var{end} [@var{type_spec}]
+ @var{var_list} (@var{fortran_spec})
+ @var{var_list} *
@end display
@cmd{PRINT EJECT} advances to the beginning of a new output page in
@vindex PRINT SPACE
@display
-PRINT SPACE OUTFILE='file-name' n_lines.
+PRINT SPACE OUTFILE='file_name' n_lines.
@end display
@cmd{PRINT SPACE} prints one or more blank lines to an output file.
@display
REPEATING DATA
- /STARTS=start-end
- /OCCURS=n_occurs
- /FILE='file-name'
- /LENGTH=length
- /CONTINUED[=cont_start-cont_end]
- /ID=id_start-id_end=id_var
+ /STARTS=@var{start}-@var{end}
+ /OCCURS=@var{n_occurs}
+ /FILE='@var{file_name}'
+ /LENGTH=@var{length}
+ /CONTINUED[=@var{cont_start}-@var{cont_end}]
+ /ID=@var{id_start}-@var{id_end}=@var{id_var}
/@{TABLE,NOTABLE@}
- /DATA=var_spec@dots{}
+ /DATA=@var{var_spec}@dots{}
-where each var_spec takes one of the forms
- var_list start-end [type_spec]
- var_list (fortran_spec)
+where each @var{var_spec} takes one of the forms
+ @var{var_list} @var{start}-@var{end} [@var{type_spec}]
+ @var{var_list} (@var{fortran_spec})
@end display
@cmd{REPEATING DATA} parses groups of data repeating in
@display
WRITE
- OUTFILE='file-name'
- RECORDS=n_lines
+ OUTFILE='@var{file_name}'
+ RECORDS=@var{n_lines}
@{NOTABLE,TABLE@}
- /[line_no] arg@dots{}
+ /[@var{line_no}] @var{arg}@dots{}
-arg takes one of the following forms:
- 'string' [start-end]
- var_list start-end [type_spec]
- var_list (fortran_spec)
- var_list *
+@var{arg} takes one of the following forms:
+ '@var{string}' [@var{start}-@var{end}]
+ @var{var_list} @var{start}-@var{end} [@var{type_spec}]
+ @var{var_list} (@var{fortran_spec})
+ @var{var_list} *
@end display
@code{WRITE} writes text or binary data to an output file.
@vindex FILTER
@display
-FILTER BY var_name.
+FILTER BY @var{var_name}.
FILTER OFF.
@end display
@cmd{FILTER} allows a boolean-valued variable to be used to select
cases from the data stream for processing.
-To set up filtering, specify BY and a variable name. Keyword
+To set up filtering, specify @subcmd{BY} and a variable name. Keyword
BY is optional but recommended. Cases which have a zero or system- or
user-missing value are excluded from analysis, but not deleted from the
data stream. Cases with other values are analyzed.
Filtering takes place immediately before cases pass to a procedure for
analysis. Only one filter variable may be active at a time. Normally,
case filtering continues until it is explicitly turned off with @code{FILTER
-OFF}. However, if @cmd{FILTER} is placed after TEMPORARY, it filters only
+OFF}. However, if @cmd{FILTER} is placed after @cmd{TEMPORARY}, it filters only
the next procedure or procedure-like command.
@node N OF CASES
@vindex N OF CASES
@display
-N [OF CASES] num_of_cases [ESTIMATED].
+N [OF CASES] @var{num_of_cases} [ESTIMATED].
@end display
@cmd{N OF CASES} limits the number of cases processed by any
@vindex SAMPLE
@display
-SAMPLE num1 [FROM num2].
+SAMPLE @var{num1} [FROM @var{num2}].
@end display
@cmd{SAMPLE} randomly samples a proportion of the cases in the active
transformation, permanently removing cases from the active dataset.
The proportion to sample can be expressed as a single number between 0
-and 1. If @code{k} is the number specified, and @code{N} is the number
+and 1. If @var{k} is the number specified, and @var{N} is the number
of currently-selected cases in the active dataset, then after
-@code{SAMPLE @var{k}.}, approximately @code{k*N} cases will be
+@subcmd{SAMPLE @var{k}.}, approximately @var{k}*@var{N} cases will be
selected.
-The proportion to sample can also be specified in the style @code{SAMPLE
+The proportion to sample can also be specified in the style @subcmd{SAMPLE
@var{m} FROM @var{N}}. With this style, cases are selected as follows:
@enumerate
@vindex SELECT IF
@display
-SELECT IF expression.
+SELECT IF @var{expression}.
@end display
-@cmd{SELECT IF} selects cases for analysis based on the value of a
-boolean expression. Cases not selected are permanently eliminated
+@cmd{SELECT IF} selects cases for analysis based on the value of
+@var{expression}. Cases not selected are permanently eliminated
from the active dataset, unless @cmd{TEMPORARY} is in effect
(@pxref{TEMPORARY}).
@vindex SPLIT FILE
@display
-SPLIT FILE [@{LAYERED, SEPARATE@}] BY var_list.
+SPLIT FILE [@{LAYERED, SEPARATE@}] BY @var{var_list}.
SPLIT FILE OFF.
@end display
variable values for the group are printed along with the analysis.
When a list of variable names is specified, one of the keywords
-LAYERED or SEPARATE may also be specified. If provided, either
+@subcmd{LAYERED} or @subcmd{SEPARATE} may also be specified. If provided, either
keyword are ignored.
Groups are formed only by @emph{adjacent} cases. To create a split
using a variable where like values are not adjacent in the working file,
you should first sort the data by that variable (@pxref{SORT CASES}).
-Specify OFF to disable @cmd{SPLIT FILE} and resume analysis of the
+Specify @subcmd{OFF} to disable @cmd{SPLIT FILE} and resume analysis of the
entire active dataset as a single group of data.
When @cmd{SPLIT FILE} is specified after @cmd{TEMPORARY}, it affects only
20
24
END DATA.
+
COMPUTE X=X/2.
+
TEMPORARY.
COMPUTE X=X+3.
+
DESCRIPTIVES X.
DESCRIPTIVES X.
@end example
@vindex WEIGHT
@display
-WEIGHT BY var_name.
+WEIGHT BY @var{var_name}.
WEIGHT OFF.
@end display
If a variable name is specified, @cmd{WEIGHT} causes the values of that
variable to be used as weighting factors for subsequent statistical
-procedures. Use of keyword BY is optional but recommended. Weighting
+procedures. Use of keyword @subcmd{BY} is optional but recommended. Weighting
variables must be numeric. Scratch variables may not be used for
weighting (@pxref{Scratch Variables}).
-When OFF is specified, subsequent statistical procedures will weight all
+When @subcmd{OFF} is specified, subsequent statistical procedures will weight all
cases equally.
A positive integer weighting factor @var{w} on a case will yield the
@vindex APPLY DICTIONARY
@display
-APPLY DICTIONARY FROM=@{'file-name',file_handle@}.
+APPLY DICTIONARY FROM=@{'@var{file_name}',@var{file_handle}@}.
@end display
@cmd{APPLY DICTIONARY} applies the variable labels, value labels,
@display
EXPORT
- /OUTFILE='file-name'
+ /OUTFILE='@var{file_name}'
/UNSELECTED=@{RETAIN,DELETE@}
- /DIGITS=n
- /DROP=var_list
- /KEEP=var_list
- /RENAME=(src_names=target_names)@dots{}
+ /DIGITS=@var{n}
+ /DROP=@var{var_list}
+ /KEEP=@var{var_list}
+ /RENAME=(@var{src_names}=@var{target_names})@dots{}
/TYPE=@{COMM,TAPE@}
/MAP
@end display
If many numbers require this many digits, the portable file may
significantly increase in size. As an alternative, the @subcmd{DIGITS}
subcommand may be used to specify the number of decimal digits of
-precision to write. DIGITS applies only to non-integers.
+precision to write. @subcmd{DIGITS} applies only to non-integers.
The @subcmd{OUTFILE} subcommand, which is the only required subcommand, specifies
the portable file to be written as a file name string or
@display
GET
- /FILE=@{'file-name',file_handle@}
- /DROP=var_list
- /KEEP=var_list
- /RENAME=(src_names=target_names)@dots{}
- /ENCODING='encoding'
+ /FILE=@{'@var{file_name}',@var{file_handle}@}
+ /DROP=@var{var_list}
+ /KEEP=@var{var_list}
+ /RENAME=(@var{src_names}=@var{target_names})@dots{}
+ /ENCODING='@var{encoding}'
@end display
@cmd{GET} clears the current dictionary and active dataset and
replaces them with the dictionary and data from a specified file.
-The @subcmd{FILE} subcommand is the only required subcommand. Specify the system
+The @subcmd{FILE} subcommand is the only required subcommand.
+Specify the system
file or portable file to be read as a string file name or
a file handle (@pxref{File Handles}).
By default, all the variables in a file are read. The DROP
subcommand can be used to specify a list of variables that are not to be
-read. By contrast, the @subcmd{KEEP} subcommand can be used to specify variable
-that are to be read, with all other variables not read.
+read. By contrast, the @subcmd{KEEP} subcommand can be used to specify
+variable that are to be read, with all other variables not read.
Normally variables in a file retain the names that they were
-saved under. Use the @subcmd{RENAME} subcommand to change these names. Specify,
+saved under. Use the @subcmd{RENAME} subcommand to change these names.
+Specify,
within parentheses, a list of variable names followed by an equals sign
(@samp{=}) and the names that they should be renamed to. Multiple
parenthesized groups of variable names can be included on a single
-@subcmd{RENAME} subcommand. Variables' names may be swapped using a @subcmd{RENAME}
-subcommand of the form @samp{/RENAME=(A B=B A)}.
+@subcmd{RENAME} subcommand.
+Variables' names may be swapped using a @subcmd{RENAME}
+subcommand of the form @subcmd{/RENAME=(@var{A} @var{B}=@var{B} @var{A})}.
Alternate syntax for the @subcmd{RENAME} subcommand allows the parentheses to be
eliminated. When this is done, only a single variable may be renamed at
-once. For instance, @samp{/RENAME=A=B}. This alternate syntax is
+once. For instance, @subcmd{/RENAME=@var{A}=@var{B}}. This alternate syntax is
deprecated.
@subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} are executed in left-to-right order.
@display
GET DATA /TYPE=@{GNM, ODS@}
- /FILE=@{'file-name'@}
- /SHEET=@{NAME 'sheet-name', INDEX n@}
- /CELLRANGE=@{RANGE 'range', FULL@}
+ /FILE=@{'@var{file_name}'@}
+ /SHEET=@{NAME '@var{sheet_name}', INDEX @var{n}@}
+ /CELLRANGE=@{RANGE '@var{range}', FULL@}
/READNAMES=@{ON, OFF@}
- /ASSUMEDVARWIDTH=n.
+ /ASSUMEDVARWIDTH=@var{n}.
@end display
@cindex Gnumeric
Gnumeric spreadsheets (@url{http://gnumeric.org}), and spreadsheets
in OpenDocument format
(@url{http://libreplanet.org/wiki/Group:OpenDocument/Software})
-can be read using the GET DATA command.
+can be read using the @cmd{GET DATA} command.
Use the @subcmd{TYPE} subcommand to indicate the file's format.
/TYPE=GNM indicates Gnumeric files,
/TYPE=ODS indicates OpenDocument.
The @subcmd{SHEET} subcommand specifies the sheet within the spreadsheet file to read.
There are two forms of the @subcmd{SHEET} subcommand.
In the first form,
-@samp{/SHEET=name @var{sheet-name}}, the string @var{sheet-name} is the
+@subcmd{/SHEET=name @var{sheet_name}}, the string @var{sheet_name} is the
name of the sheet to read.
-In the second form, @samp{/SHEET=index @var{idx}}, @var{idx} is a
+In the second form, @subcmd{/SHEET=index @var{idx}}, @var{idx} is a
integer which is the index of the sheet to read.
The first sheet has the index 1.
If the @subcmd{SHEET} subcommand is omitted, then the command will read the
first sheet in the file.
The @subcmd{CELLRANGE} subcommand specifies the range of cells within the sheet to read.
-If the subcommand is given as @samp{/CELLRANGE=FULL}, then the entire
+If the subcommand is given as @subcmd{/CELLRANGE=FULL}, then the entire
sheet is read.
To read only part of a sheet, use the form
-@samp{/CELLRANGE=range '@var{top-left-cell}:@var{bottom-right-cell}'}.
-For example, the subcommand @samp{/CELLRANGE=range 'C3:P19'} reads
+@subcmd{/CELLRANGE=range '@var{top_left_cell}:@var{bottom_right_cell}'}.
+For example, the subcommand @subcmd{/CELLRANGE=range 'C3:P19'} reads
columns C--P, and rows 3--19 inclusive.
If no @subcmd{CELLRANGE} subcommand is given, then the entire sheet is read.
-If @samp{/READNAMES=ON} is specified, then the contents of cells of
+If @subcmd{/READNAMES=ON} is specified, then the contents of cells of
the first row are used as the names of the variables in which to store
the data from subsequent rows. This is the default.
-If @samp{/READNAMES=OFF} is
+If @subcmd{/READNAMES=OFF} is
used, then the variables receive automatically assigned names.
The @subcmd{ASSUMEDVARWIDTH} subcommand specifies the maximum width of string
@display
GET DATA /TYPE=PSQL
- /CONNECT=@{connection info@}
- /SQL=@{query@}
- [/ASSUMEDVARWIDTH=n]
+ /CONNECT=@{@var{connection info}@}
+ /SQL=@{@var{query}@}
+ [/ASSUMEDVARWIDTH=@var{w}]
[/UNENCRYPTED]
- [/BSIZE=n].
+ [/BSIZE=@var{n}].
@end display
@cindex postgres
The @subcmd{UNENCRYPTED} subcommand allows data to be retrieved over an insecure
connection.
-If the connection is not encrypted, and the @subcmd{UNENCRYPTED} subcommand is not
-given, then an error will occur.
+If the connection is not encrypted, and the @subcmd{UNENCRYPTED} subcommand is
+not given, then an error will occur.
Whether or not the connection is
encrypted depends upon the underlying psql library and the
capabilities of the database server.
@display
GET DATA /TYPE=TXT
- /FILE=@{'file-name',file_handle@}
+ /FILE=@{'@var{file_name}',@var{file_handle}@}
[/ARRANGEMENT=@{DELIMITED,FIXED@}]
- [/FIRSTCASE=@{first_case@}]
- [/IMPORTCASE=@{ALL,FIRST max_cases,PERCENT percent@}]
+ [/FIRSTCASE=@{@var{first_case}@}]
+ [/IMPORTCASE=@{ALL,FIRST @var{max_cases},PERCENT @var{percent}@}]
@dots{}additional subcommands depending on ARRANGEMENT@dots{}
@end display
fixed columnar format, much like DATA LIST (@pxref{DATA LIST}).
The @subcmd{FILE} subcommand is mandatory. Specify the file to be read as
-a string file name or (for textual data
-only) a file handle (@pxref{File Handles}).
+a string file name or (for textual data only) a
+file handle (@pxref{File Handles}).
The @subcmd{ARRANGEMENT} subcommand determines the file's basic format.
DELIMITED, the default setting, specifies that fields in the input
@subcmd{IMPORTCASE} can be used to limit the number of cases read from the
input file. With the default setting, ALL, all cases in the file are
-read. Specify FIRST @i{max_cases} to read at most @i{max_cases} cases
-from the file. Use PERCENT @i{percent} to read only @i{percent}
+read. Specify FIRST @var{max_cases} to read at most @var{max_cases} cases
+from the file. Use @subcmd{PERCENT @var{percent}} to read only @var{percent}
percent, approximately, of the cases contained in the file. (The
percentage is approximate, because there is no way to accurately count
the number of cases in the file without reading the entire file. The
@display
GET DATA /TYPE=TXT
- /FILE=@{'file-name',file_handle@}
+ /FILE=@{'@var{file_name}',@var{file_handle}@}
[/ARRANGEMENT=@{DELIMITED,FIXED@}]
- [/FIRSTCASE=@{first_case@}]
- [/IMPORTCASE=@{ALL,FIRST max_cases,PERCENT percent@}]
-
- /DELIMITERS="delimiters"
- [/QUALIFIER="quotes" [/ESCAPE]]
- [/DELCASE=@{LINE,VARIABLES n_variables@}]
- /VARIABLES=del_var [del_var]@dots{}
-where each del_var takes the form:
+ [/FIRSTCASE=@{@var{first_case}@}]
+ [/IMPORTCASE=@{ALL,FIRST @var{max_cases},PERCENT @var{percent}@}]
+
+ /DELIMITERS="@var{delimiters}"
+ [/QUALIFIER="@var{quotes}" [/ESCAPE]]
+ [/DELCASE=@{LINE,VARIABLES @var{n_variables}@}]
+ /VARIABLES=@var{del_var1} [@var{del_var2}]@dots{}
+where each @var{del_var} takes the form:
variable format
@end display
@node GET DATA /TYPE=TXT /ARRANGEMENT=FIXED
@subsubsection Reading Fixed Columnar Data
+@c (modify-syntax-entry ?_ "w")
+@c (modify-syntax-entry ?' "'")
+@c (modify-syntax-entry ?@ "'")
+
@display
GET DATA /TYPE=TXT
- /FILE=@{'file-name',file_handle@}
+ /FILE=@{'file_name',@var{file_handle}@}
[/ARRANGEMENT=@{DELIMITED,FIXED@}]
- [/FIRSTCASE=@{first_case@}]
- [/IMPORTCASE=@{ALL,FIRST max_cases,PERCENT percent@}]
-
- [/FIXCASE=n]
- /VARIABLES fixed_var [fixed_var]@dots{}
- [/rec# fixed_var [fixed_var]@dots{}]@dots{}
-where each fixed_var takes the form:
- variable start-end format
+ [/FIRSTCASE=@{@var{first_case}@}]
+ [/IMPORTCASE=@{ALL,FIRST @var{max_cases},PERCENT @var{percent}@}]
+
+ [/FIXCASE=@var{n}]
+ /VARIABLES @var{fixed_var} [@var{fixed_var}]@dots{}
+ [/rec# @var{fixed_var} [@var{fixed_var}]@dots{}]@dots{}
+where each @var{fixed_var} takes the form:
+ @var{variable} @var{start}-@var{end} @var{format}
@end display
-The GET DATA command with TYPE=TXT and ARRANGEMENT=FIXED reads input
+The @cmd{GET DATA} command with TYPE=TXT and ARRANGEMENT=FIXED reads input
data from text files in fixed format, where each field is located in
particular fixed column positions within records of a case. Its
capabilities are similar to those of DATA LIST FIXED (@pxref{DATA LIST
@display
IMPORT
- /FILE='file-name'
+ /FILE='@var{file_name}'
/TYPE=@{COMM,TAPE@}
- /DROP=var_list
- /KEEP=var_list
- /RENAME=(src_names=target_names)@dots{}
+ /DROP=@var{var_list}
+ /KEEP=@var{var_list}
+ /RENAME=(@var{src_names}=@var{target_names})@dots{}
@end display
The @cmd{IMPORT} transformation clears the active dataset dictionary and
@display
SAVE
- /OUTFILE=@{'file-name',file_handle@}
+ /OUTFILE=@{'@var{file_name}',@var{file_handle}@}
/UNSELECTED=@{RETAIN,DELETE@}
/@{COMPRESSED,UNCOMPRESSED@}
/PERMISSIONS=@{WRITEABLE,READONLY@}
- /DROP=var_list
- /KEEP=var_list
- /VERSION=version
- /RENAME=(src_names=target_names)@dots{}
+ /DROP=@var{var_list}
+ /KEEP=@var{var_list}
+ /VERSION=@var{version}
+ /RENAME=(@var{src_names}=@var{target_names})@dots{}
/NAMES
/MAP
@end display
These can be excluded by specifying @subcmd{DELETE} on the @subcmd{UNSELECTED}
subcommand. Specifying @subcmd{RETAIN} makes the default explicit.
-The @subcmd{COMPRESS} and @subcmd{UNCOMPRESS} subcommand determine whether the saved
-system file is compressed. By default, system files are compressed.
+The @subcmd{COMPRESS} and @subcmd{UNCOMPRESS} subcommand determine whether
+the saved system file is compressed. By default, system files are compressed.
This default can be changed with the SET command (@pxref{SET}).
The @subcmd{PERMISSIONS} subcommand specifies permissions for the new system
equals sign (@samp{=}) and the names that they should be renamed to.
Multiple parenthesized groups of variable names can be included on a
single @subcmd{RENAME} subcommand. Variables' names may be swapped using a
-@subcmd{RENAME} subcommand of the form @samp{/RENAME=(A B=B A)}.
+@subcmd{RENAME} subcommand of the
+form @subcmd{/RENAME=(@var{A} @var{B}=@var{B} @var{A})}.
Alternate syntax for the @subcmd{RENAME} subcommand allows the parentheses to be
eliminated. When this is done, only a single variable may be renamed at
-once. For instance, @samp{/RENAME=A=B}. This alternate syntax is
+once. For instance, @subcmd{/RENAME=@var{A}=@var{B}}. This alternate syntax is
deprecated.
-DROP, KEEP, and RENAME are performed in left-to-right order. They
+@subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} are performed in
+left-to-right order. They
each may be present any number of times. @cmd{SAVE} never modifies
-the active dataset. DROP, KEEP, and RENAME only affect the system file
-written to disk.
+the active dataset. @subcmd{DROP}, @subcmd{KEEP}, and @subcmd{RENAME} only
+affect the system file written to disk.
The @subcmd{VERSION} subcommand specifies the version of the file format. Valid
versions are 2 and 3. The default version is 3. In version 2 system
@display
SAVE TRANSLATE
- /OUTFILE=@{'file-name',file_handle@}
+ /OUTFILE=@{'@var{file_name}',@var{file_handle}@}
/TYPE=@{CSV,TAB@}
[/REPLACE]
[/MISSING=@{IGNORE,RECODE@}]
- [/DROP=var_list]
- [/KEEP=var_list]
- [/RENAME=(src_names=target_names)@dots{}]
+ [/DROP=@var{var_list}]
+ [/KEEP=@var{var_list}]
+ [/RENAME=(@var{src_names}=@var{target_names})@dots{}]
[/UNSELECTED=@{RETAIN,DELETE@}]
[/MAP]
@display
SAVE TRANSLATE
- /OUTFILE=@{'file-name',file_handle@}
+ /OUTFILE=@{'@var{file_name}',@var{file_handle}@}
/TYPE=CSV
[/REPLACE]
[/MISSING=@{IGNORE,RECODE@}]
- [/DROP=var_list]
- [/KEEP=var_list]
- [/RENAME=(src_names=target_names)@dots{}]
+ [/DROP=@var{var_list}]
+ [/KEEP=@var{var_list}]
+ [/RENAME=(@var{src_names}=@var{target_names})@dots{}]
[/UNSELECTED=@{RETAIN,DELETE@}]
[/FIELDNAMES]
[/CELLS=@{VALUES,LABELS@}]
- [/TEXTOPTIONS DELIMITER='delimiter']
- [/TEXTOPTIONS QUALIFIER='qualifier']
+ [/TEXTOPTIONS DELIMITER='@var{delimiter}']
+ [/TEXTOPTIONS QUALIFIER='@var{qualifier}']
[/TEXTOPTIONS DECIMAL=@{DOT,COMMA@}]
[/TEXTOPTIONS FORMAT=@{PLAIN,VARIABLE@}]
@end display
@vindex SYSFILE INFO
@display
-SYSFILE INFO FILE='file-name'.
+SYSFILE INFO FILE='@var{file_name}'.
@end display
@cmd{SYSFILE INFO} reads the dictionary in a system file and
@display
XEXPORT
- /OUTFILE='file-name'
- /DIGITS=n
- /DROP=var_list
- /KEEP=var_list
- /RENAME=(src_names=target_names)@dots{}
+ /OUTFILE='@var{file_name}'
+ /DIGITS=@var{n}
+ /DROP=@var{var_list}
+ /KEEP=@var{var_list}
+ /RENAME=(@var{src_names}=@var{target_names})@dots{}
/TYPE=@{COMM,TAPE@}
/MAP
@end display
@display
XSAVE
- /OUTFILE='file-name'
+ /OUTFILE='@var{file_name}'
/@{COMPRESSED,UNCOMPRESSED@}
/PERMISSIONS=@{WRITEABLE,READONLY@}
- /DROP=var_list
- /KEEP=var_list
- /VERSION=version
- /RENAME=(src_names=target_names)@dots{}
+ /DROP=@var{var_list}
+ /KEEP=@var{var_list}
+ /VERSION=@var{version}
+ /RENAME=(@var{src_names}=@var{target_names})@dots{}
/NAMES
/MAP
@end display
condition on @cmd{END LOOP} will always execute at least once.
If neither the index clause nor either condition clause is
-present, then the loop is executed MXLOOPS (@pxref{SET}) times.
-The default MXLOOPS is 40.
+present, then the loop is executed @var{max_loops} (@pxref{SET}) times.
+The default value of @var{max_loops} is 40.
@cmd{BREAK} also terminates @cmd{LOOP} execution (@pxref{BREAK}).
my ($command, $description)
= /^\s*UNIMPL_CMD\s*\(\s*"([^"]*)"\s*,\s*"([^"]*)"\)\s*$/
or next;
- print "\@item $command\n$description\n\n";
+ print "\@item \@cmd{$command}\n$description\n\n";
}
print "\@end table\n";
@chapter Invoking @command{psppire}
@section The graphic user interface
@cindex Graphic user interface
-@cindex @pspp{}IRE
+@cindex PSPPIRE
-The @pspp{}IRE graphic user interface for @pspp{} can perform all
+The PSPPIRE graphic user interface for @pspp{} can perform all
functionality of the command line interface. In addition it gives an
instantaneous view of the data, variables and statistical output.
referenced. This section describes the details of command ordering,
but most users will have no need to refer to them.
-@pspp{} possesses five internal states, called initial, INPUT PROGRAM,
-FILE TYPE, transformation, and procedure states. (Please note the
+@pspp{} possesses five internal states, called @dfn{initial}, @dfn{input-program}
+@dfn{file-type}, @dfn{transformation}, and @dfn{procedure} states. (Please note the
distinction between the @cmd{INPUT PROGRAM} and @cmd{FILE TYPE}
-@emph{commands} and the INPUT PROGRAM and FILE TYPE @emph{states}.)
+@emph{commands} and the @dfn{input-program} and @dfn{file-type} @emph{states}.)
@pspp{} starts in the initial state. Each successful completion
of a command may cause a state transition. Each type of command has its
@item @cmd{INPUT PROGRAM}
@itemize @bullet
@item
-Invalid in INPUT PROGRAM and FILE TYPE states.
+Invalid in input-program and file-type states.
@item
-Causes a transition to the INPUT PROGRAM state.
+Causes a transition to the intput-program state.
@item
Clears the active dataset.
@end itemize
@item @cmd{FILE TYPE}
@itemize @bullet
@item
-Invalid in INPUT PROGRAM and FILE TYPE states.
+Invalid in intput-program and file-type states.
@item
-Causes a transition to the FILE TYPE state.
+Causes a transition to the file-type state.
@item
Clears the active dataset.
@end itemize
@item Other file definition commands
@itemize @bullet
@item
-Invalid in INPUT PROGRAM and FILE TYPE states.
+Invalid in input-program and file-type states.
@item
Cause a transition to the transformation state.
@item
@item Transformations
@itemize @bullet
@item
-Invalid in initial and FILE TYPE states.
+Invalid in initial and file-type states.
@item
Cause a transition to the transformation state.
@end itemize
@item Restricted transformations
@itemize @bullet
@item
-Invalid in initial, INPUT PROGRAM, and FILE TYPE states.
+Invalid in initial, input-program, and file-type states.
@item
Cause a transition to the transformation state.
@end itemize
@item Procedures
@itemize @bullet
@item
-Invalid in initial, INPUT PROGRAM, and FILE TYPE states.
+Invalid in initial, input-program, and file-type states.
@item
Cause a transition to the procedure state.
@end itemize
most of the time, the distinction between print and write formats is
unimportant.
-Input and output formats are specified to @pspp{} with a @dfn{format
-specification} of the form @code{TYPEw} or @code{TYPEw.d}, where
-@code{TYPE} is one of the format types described later, @code{w} is a
-field width measured in columns, and @code{d} is an optional number of
-decimal places. If @code{d} is omitted, a value of 0 is assumed. Some
-formats do not allow a nonzero @code{d} to be specified.
+Input and output formats are specified to @pspp{} with
+a @dfn{format specification} of the
+form @subcmd{@var{TYPE}@var{w}} or @code{TYPE@var{w}.@var{d}}, where
+@var{TYPE} is one of the format types described later, @var{w} is a
+field width measured in columns, and @var{d} is an optional number of
+decimal places. If @var{d} is omitted, a value of 0 is assumed. Some
+formats do not allow a nonzero @var{d} to be specified.
The following sections describe the input and output formats supported
by @pspp{}.
@c Use this macro to refer to PSPP itself . Not when giving a shell command line example.
@macro pspp
-PSPP
+@sc{pspp}
@end macro
This manual is for GNU PSPP version @value{VERSION},
software for statistical analysis.
-Copyright @copyright{} 1997, 1998, 2004, 2005, 2009 Free Software Foundation, Inc.
+Copyright @copyright{} 1997, 1998, 2004, 2005, 2009, 2012 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
@node REGRESSION
-@comment node-name, next, previous, up
@section REGRESSION
@cindex regression
@cindex linear regression
-The REGRESSION procedure fits linear models to data via least-squares
+The @cmd{REGRESSION} procedure fits linear models to data via least-squares
estimation. The procedure is appropriate for data which satisfy those
assumptions typical in linear regression:
@itemize @bullet
@item The data set contains @math{n} observations of a dependent variable, say
@math{Y_1,@dots{},Y_n}, and @math{n} observations of one or more explanatory
-variables. Let @math{X_{11}, X_{12}}, @dots{}, @math{X_{1n}} denote the @math{n} observations of the
-first explanatory variable; @math{X_{21}},@dots{},@math{X_{2n}} denote the @math{n} observations of the
-second explanatory variable; @math{X_{k1}},@dots{},@math{X_{kn}} denote the @math{n} observations of the kth
-explanatory variable.
+variables.
+Let @math{X_{11}, X_{12}}, @dots{}, @math{X_{1n}} denote the @math{n} observations
+of the first explanatory variable;
+@math{X_{21}},@dots{},@math{X_{2n}} denote the @math{n} observations of the second
+explanatory variable;
+@math{X_{k1}},@dots{},@math{X_{kn}} denote the @math{n} observations of
+the @math{k}th explanatory variable.
@item The dependent variable @math{Y} has the following relationship to the
explanatory variables:
@math{Y_i = b_0 + b_1 X_{1i} + ... + b_k X_{ki} + Z_i}
where @math{b_0, b_1, @dots{}, b_k} are unknown
coefficients, and @math{Z_1,@dots{},Z_n} are independent, normally
-distributed ``noise'' terms with mean zero and common variance. The noise, or
-``error'' terms are unobserved. This relationship is called the
-``linear model.''
+distributed @dfn{noise} terms with mean zero and common variance.
+The noise, or @dfn{error} terms are unobserved.
+This relationship is called the @dfn{linear model}.
@end itemize
-The REGRESSION procedure estimates the coefficients
+The @cmd{REGRESSION} procedure estimates the coefficients
@math{b_0,@dots{},b_k} and produces output relevant to inferences for the
linear model.
-@c If you add any new commands, then don't forget to remove the entry in
-@c not-implemented.texi
-
@menu
* Syntax:: Syntax definition.
* Examples:: Using the REGRESSION procedure.
@vindex REGRESSION
@display
REGRESSION
- /VARIABLES=var_list
- /DEPENDENT=var_list
+ /VARIABLES=@var{var_list}
+ /DEPENDENT=@var{var_list}
/STATISTICS=@{ALL, DEFAULTS, R, COEFF, ANOVA, BCOV@}
/SAVE=@{PRED, RESID@}
@end display
statistics relevant to the linear model specified by the user.
The @subcmd{VARIABLES} subcommand, which is required, specifies the list of
-variables to be analyzed. Keyword VARIABLES is required. The
+variables to be analyzed. Keyword @subcmd{VARIABLES} is required. The
@subcmd{DEPENDENT} subcommand specifies the dependent variable of the linear
model. The @subcmd{DEPENDENT} subcommand is required. All variables listed in
the @subcmd{VARIABLES} subcommand, but not listed in the @subcmd{DEPENDENT} subcommand,
@vindex DESCRIPTIVES
@display
DESCRIPTIVES
- /VARIABLES=var_list
+ /VARIABLES=@var{var_list}
/MISSING=@{VARIABLE,LISTWISE@} @{INCLUDE,NOINCLUDE@}
/FORMAT=@{LABELS,NOLABELS@} @{NOINDEX,INDEX@} @{LINE,SERIAL@}
/SAVE
@vindex FREQUENCIES
@display
FREQUENCIES
- /VARIABLES=var_list
- /FORMAT=@{TABLE,NOTABLE,LIMIT(limit)@}
+ /VARIABLES=@var{var_list}
+ /FORMAT=@{TABLE,NOTABLE,LIMIT(@var{limit})@}
@{AVALUE,DVALUE,AFREQ,DFREQ@}
/MISSING=@{EXCLUDE,INCLUDE@}
/STATISTICS=@{DEFAULT,MEAN,SEMEAN,MEDIAN,MODE,STDDEV,VARIANCE,
KURTOSIS,SKEWNESS,RANGE,MINIMUM,MAXIMUM,SUM,
SESKEWNESS,SEKURTOSIS,ALL,NONE@}
- /NTILES=ntiles
+ /NTILES=@var{ntiles}
/PERCENTILES=percent@dots{}
- /HISTOGRAM=[MINIMUM(x_min)] [MAXIMUM(x_max)]
- [@{FREQ[(y_max)],PERCENT[(y_max)]@}] [@{NONORMAL,NORMAL@}]
- /PIECHART=[MINIMUM(x_min)] [MAXIMUM(x_max)]
+ /HISTOGRAM=[MINIMUM(@var{x_min})] [MAXIMUM(@var{x_max})]
+ [@{FREQ[(@var{y_max})],PERCENT[(@var{y_max})]@}] [@{NONORMAL,NORMAL@}]
+ /PIECHART=[MINIMUM(@var{x_min})] [MAXIMUM(@var{x_max})]
[@{FREQ,PERCENT@}] [@{NOMISSING,MISSING@}]
(These options are not currently implemented.)
@itemize @subcmd{}
@item
-TABLE, the default, causes a frequency table to be output for every
-variable specified. NOTABLE prevents them from being output. LIMIT
+@subcmd{TABLE}, the default, causes a frequency table to be output for every
+variable specified. @subcmd{NOTABLE} prevents them from being output. @subcmd{LIMIT}
with a numeric argument causes them to be output except when there are
more than the specified number of values in the table.
@item
Normally frequency tables are sorted in ascending order by value. This
-is AVALUE. DVALUE tables are sorted in descending order by value.
-AFREQ and DFREQ tables are sorted in ascending and descending order,
+is @subcmd{AVALUE}. @subcmd{DVALUE} tables are sorted in descending order by value.
+@subcmd{AFREQ} and @subcmd{DFREQ} tables are sorted in ascending and descending order,
respectively, by frequency count.
@end itemize
mean, minimum, and maximum are reported for each variable.
@cindex percentiles
-PERCENTILES causes the specified percentiles to be reported.
+@subcmd{PERCENTILES} causes the specified percentiles to be reported.
The percentiles should be presented at a list of numbers between 0
and 100 inclusive.
The @subcmd{NTILES} subcommand causes the percentiles to be reported at the
boundaries of the data set divided into the specified number of ranges.
-For instance, @code{/NTILES=4} would cause quartiles to be reported.
+For instance, @subcmd{/NTILES=4} would cause quartiles to be reported.
@cindex histogram
The @subcmd{HISTOGRAM} subcommand causes the output to include a histogram for
each specified numeric variable. The X axis by default ranges from
-the minimum to the maximum value observed in the data, but the MINIMUM
-and MAXIMUM keywords can set an explicit range. Specify NORMAL to
+the minimum to the maximum value observed in the data, but the @subcmd{MINIMUM}
+and @subcmd{MAXIMUM} keywords can set an explicit range. Specify @subcmd{NORMAL} to
superimpose a normal curve on the histogram. Histograms are not
created for string variables.
The @subcmd{PIECHART} subcommand adds a pie chart for each variable to the data. Each
slice represents one value, with the size of the slice proportional to
the value's frequency. By default, all non-missing values are given
-slices. The MINIMUM and MAXIMUM keywords can be used to limit the
-displayed slices to a given range of values. The MISSING keyword adds
+slices. The @subcmd{MINIMUM} and @subcmd{MAXIMUM} keywords can be used to limit the
+displayed slices to a given range of values. The @subcmd{MISSING} keyword adds
slices for missing values.
-The FREQ and PERCENT options on @subcmd{HISTOGRAM} and @subcmd{PIECHART} are accepted
+The @subcmd{FREQ} and @subcmd{PERCENT} options on @subcmd{HISTOGRAM} and @subcmd{PIECHART} are accepted
but not currently honoured.
@node EXAMINE
Each unique combination of the values of @var{factorvar} and
@var{subfactorvar} divide the dataset into @dfn{cells}.
Statistics will be calculated for each cell
-and for the entire dataset (unless NOTOTAL is given).
+and for the entire dataset (unless @subcmd{NOTOTAL} is given).
The @subcmd{STATISTICS} subcommand specifies which statistics to show.
-DESCRIPTIVES will produce a table showing some parametric and
+@subcmd{DESCRIPTIVES} will produce a table showing some parametric and
non-parametrics statistics.
-EXTREME produces a table showing the extremities of each cell.
+@subcmd{EXTREME} produces a table showing the extremities of each cell.
A number in parentheses, @var{n} determines
how many upper and lower extremities to show.
The default number is 5.
-The subcommands TOTAL and NOTOTAL are mutually exclusive.
-If TOTAL appears, then statistics will be produced for the entire dataset
+The subcommands @subcmd{TOTAL} and @subcmd{NOTOTAL} are mutually exclusive.
+If @subcmd{TOTAL} appears, then statistics will be produced for the entire dataset
as well as for each cell.
-If NOTOTAL appears, then statistics will be produced only for the cells
+If @subcmd{NOTOTAL} appears, then statistics will be produced only for the cells
(unless no factor variables have been given).
These subcommands have no effect if there have been no factor variables
specified.
@cindex histogram
@cindex npplot
The @subcmd{PLOT} subcommand specifies which plots are to be produced if any.
-Available plots are HISTOGRAM, NPPLOT and BOXPLOT.
+Available plots are @subcmd{HISTOGRAM}, @subcmd{NPPLOT} and @subcmd{BOXPLOT}.
They can all be used to visualise how closely each cell conforms to a
normal distribution.
Boxplots will also show you the outliers and extreme values.
The @subcmd{COMPARE} subcommand is only relevant if producing boxplots, and it is only
useful there is more than one dependent variable and at least one factor.
If
-/COMPARE=GROUPS is specified, then one plot per dependent variable is produced,
+@subcmd{/COMPARE=GROUPS} is specified, then one plot per dependent variable is produced,
each of which contain boxplots for all the cells.
-If /COMPARE=VARIABLES is specified, then one plot per cell is produced,
+If @subcmd{/COMPARE=VARIABLES} is specified, then one plot per cell is produced,
each containing one boxplot per dependent variable.
If the @subcmd{/COMPARE} subcommand is omitted, then @pspp{} behaves as if
-/COMPARE=GROUPS were given.
+@subcmd{/COMPARE=GROUPS} were given.
-The @subcmd{ID} subcommand is relevant only if /PLOT=BOXPLOT or
-/STATISTICS=EXTREME has been given.
+The @subcmd{ID} subcommand is relevant only if @subcmd{/PLOT=BOXPLOT} or
+@subcmd{/STATISTICS=EXTREME} has been given.
If given, it shoule provide the name of a variable which is to be used
to labels extreme values and outliers.
Numeric or string variables are permissible.
calculate the 5, 10, 25, 50, 75, 90, 95 percentiles using the
HAVERAGE algorithm.
-The @subcmd{TOTAL} and @subcmd{NOTOTAL} subcommands are mutually exclusive. If NOTOTAL
+The @subcmd{TOTAL} and @subcmd{NOTOTAL} subcommands are mutually exclusive. If @subcmd{NOTOTAL}
is given and factors have been specified in the @subcmd{VARIABLES} subcommand,
then then statistics for the unfactored dependent variables are
produced in addition to the factored variables. If there are no
-factors specified then TOTAL and NOTOTAL have no effect.
+factors specified then @subcmd{TOTAL} and @subcmd{NOTOTAL} have no effect.
The following example will generate descriptive statistics and histograms for
distinct value
of @var{gender} @emph{and} for each distinct combination of the values
of @var{gender} and @var{race}.
-Since the NOTOTAL keyword is given, statistics and histograms for
+Since the @subcmd{NOTOTAL} keyword is given, statistics and histograms for
@var{score1} and @var{score2} covering the whole dataset are not produced.
@example
EXAMINE @var{score1} @var{score2} BY
A table showing the 3 largest and the 3 smallest values of @var{height} and
@var{weight} for each gender, and for the whole dataset will be shown.
Boxplots will also be produced.
-Because /COMPARE = GROUPS was given, boxplots for male and female will be
+Because @subcmd{/COMPARE = GROUPS} was given, boxplots for male and female will be
shown in the same graphic, allowing us to easily see the difference between
the genders.
Since the variable @var{name} was specified on the @subcmd{ID} subcommand, this will be
@vindex CORRELATIONS
@display
CORRELATIONS
- /VARIABLES = varlist [ WITH varlist ]
+ /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
[
.
.
.
- /VARIABLES = varlist [ WITH varlist ]
- /VARIABLES = varlist [ WITH varlist ]
+ /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
+ /VARIABLES = @var{var_list} [ WITH @var{var_list} ]
]
[ /PRINT=@{TWOTAIL, ONETAIL@} @{SIG, NOSIG@} ]
The @cmd{MISSING} subcommand determines the handling of missing variables.
If INCLUDE is set, then user-missing values are included in the
calculations, but system-missing values are not.
-If EXCLUDE is set, which is the default, user-missing
+If @subcmd{EXCLUDE} is set, which is the default, user-missing
values are excluded as well as system-missing values.
This is the default.
-If LISTWISE is set, then the entire case is excluded from analysis
+If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
whenever any variable specified in any @cmd{/VARIABLES} subcommand
contains a missing value.
-If PAIRWISE is set, then a case is considered missing only if either of the
+If @subcmd{PAIRWISE} is set, then a case is considered missing only if either of the
values for the particular coefficient are missing.
-The default is PAIRWISE.
+The default is @subcmd{PAIRWISE}.
The @subcmd{PRINT} subcommand is used to control how the reported significance values are printed.
-If the TWOTAIL option is used, then a two-tailed test of significance is
-printed. If the ONETAIL option is given, then a one-tailed test is used.
-The default is TWOTAIL.
+If the @subcmd{TWOTAIL} option is used, then a two-tailed test of significance is
+printed. If the @subcmd{ONETAIL} option is given, then a one-tailed test is used.
+The default is @subcmd{TWOTAIL}.
-If the NOSIG option is specified, then correlation coefficients with significance less than
+If the @subcmd{NOSIG} option is specified, then correlation coefficients with significance less than
0.05 are highlighted.
-If SIG is specified, then no highlighting is performed. This is the default.
+If @subcmd{SIG} is specified, then no highlighting is performed. This is the default.
@cindex covariance
The @subcmd{STATISTICS} subcommand requests additional statistics to be displayed. The keyword
estimator of the standard deviation are displayed.
These statistics will be displayed in a separated table, for all the variables listed
in any @subcmd{/VARIABLES} subcommand.
-The XPROD keyword requests cross-product deviations and covariance estimators to
+The @subcmd{XPROD} keyword requests cross-product deviations and covariance estimators to
be displayed for each pair of variables.
-The keyword ALL is the union of DESCRIPTIVES and XPROD.
+The keyword ALL is the union of @subcmd{DESCRIPTIVES} and @subcmd{XPROD}.
@node CROSSTABS
@section CROSSTABS
@vindex CROSSTABS
@display
CROSSTABS
- /TABLES=var_list BY var_list [BY var_list]@dots{}
+ /TABLES=@var{var_list} BY @var{var_list} [BY @var{var_list}]@dots{}
/MISSING=@{TABLE,INCLUDE,REPORT@}
/WRITE=@{NONE,CELLS,ALL@}
/FORMAT=@{TABLES,NOTABLES@}
KAPPA,ETA,CORR,ALL,NONE@}
(Integer mode.)
- /VARIABLES=var_list (low,high)@dots{}
+ /VARIABLES=@var{var_list} (@var{low},@var{high})@dots{}
@end display
The @cmd{CROSSTABS} procedure displays crosstabulation
NOTABLES suppresses them.
@item
-PIVOT, the default, causes each @subcmd{TABLES} subcommand to be displayed in a
-pivot table format. NOPIVOT causes the old-style crosstabulation format
+@subcmd{PIVOT}, the default, causes each @subcmd{TABLES} subcommand to be displayed in a
+pivot table format. @subcmd{NOPIVOT} causes the old-style crosstabulation format
to be used.
@item
-AVALUE, the default, causes values to be sorted in ascending order.
-DVALUE asserts a descending sort order.
+@subcmd{AVALUE}, the default, causes values to be sorted in ascending order.
+@subcmd{DVALUE} asserts a descending sort order.
@item
-INDEX/NOINDEX is currently ignored.
+@subcmd{INDEX} and @subcmd{NOINDEX} are currently ignored.
@item
-BOX/NOBOX is currently ignored.
+@subcmd{BOX} and @subcmd{NOBOX} is currently ignored.
@end itemize
The @subcmd{CELLS} subcommand controls the contents of each cell in the displayed
Suppress cells entirely.
@end table
-@samp{/CELLS} without any settings specified requests COUNT, ROW,
-COLUMN, and TOTAL. If CELLS is not specified at all then only COUNT
+@samp{/CELLS} without any settings specified requests @subcmd{COUNT}, @subcmd{ROW},
+@subcmd{COLUMN}, and @subcmd{TOTAL}. If CELLS is not specified at all then only @subcmd{COUNT}
will be selected.
The @subcmd{STATISTICS} subcommand selects statistics for computation:
@cindex data reduction
@display
-FACTOR VARIABLES=var_list
+FACTOR VARIABLES=@var{var_list}
[ /METHOD = @{CORRELATION, COVARIANCE@} ]
Identical to INITIAL and EXTRACTION.
@end itemize
-If /PLOT=EIGEN is given, then a ``Scree'' plot of the eigenvalues will be printed. This can be useful for visualizing
+If @subcmd{/PLOT=EIGEN} is given, then a ``Scree'' plot of the eigenvalues will be printed. This can be useful for visualizing
which factors (components) should be retained.
The @subcmd{/FORMAT} subcommand determined how data are to be displayed in loading matrices. If SORT is specified, then the variables
than @var{n} will not be printed. If the keyword DEFAULT is given, or if no @subcmd{/FORMAT} subcommand is given, then no sorting is
performed, and all coefficients will be printed.
-The @subcmd{/CRITERIA} subcommand is used to specify how the number of extracted factors (components) are chosen. If FACTORS(@var{n}) is
-specified, where @var{n} is an integer, then @var{n} factors will be extracted. Otherwise, the MINEIGEN setting will
-be used. MINEIGEN(@var{l}) requests that all factors whose eigenvalues are greater than or equal to @var{l} are extracted.
-The default value of @var{l} is 1. The ECONVERGE and ITERATE settings have effect only when iterative algorithms for factor
-extraction (such as Principal Axis Factoring) are used. ECONVERGE(@var{delta}) specifies that iteration should cease when
+The @subcmd{/CRITERIA} subcommand is used to specify how the number of extracted factors (components) are chosen.
+If @subcmd{FACTORS(@var{n})} is
+specified, where @var{n} is an integer, then @var{n} factors will be extracted. Otherwise, the @subcmd{MINEIGEN} setting will
+be used. @subcmd{MINEIGEN(@var{l})} requests that all factors whose eigenvalues are greater than or equal to @var{l} are extracted.
+The default value of @var{l} is 1. The @subcmd{ECONVERGE} and @subcmd{ITERATE} settings have effect only when iterative algorithms for factor
+extraction (such as Principal Axis Factoring) are used. @subcmd{ECONVERGE(@var{delta})} specifies that
+iteration should cease when
the maximum absolute value of the communality estimate between one iteration and the previous is less than @var{delta}. The
default value of @var{delta} is 0.001.
-The ITERATE(@var{m}) setting sets the maximum number of iterations to @var{m}. The default value of @var{m} is 25.
+The @subcmd{ITERATE(@var{m})} setting sets the maximum number of iterations to @var{m}. The default value of @var{m} is 25.
The @cmd{MISSING} subcommand determines the handling of missing variables.
-If INCLUDE is set, then user-missing values are included in the
+If @subcmd{INCLUDE} is set, then user-missing values are included in the
calculations, but system-missing values are not.
-If EXCLUDE is set, which is the default, user-missing
+If @subcmd{EXCLUDE} is set, which is the default, user-missing
values are excluded as well as system-missing values.
This is the default.
If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
@display
MEANS [TABLES =]
- @{varlist@}
- [ BY @{varlist@} [BY @{varlist@} [BY @{varlist@} @dots{} ]]]
+ @{@var{var_list}@}
+ [ BY @{@var{var_list}@} [BY @{@var{var_list}@} [BY @{@var{var_list}@} @dots{} ]]]
- [ /@{varlist@}
- [ BY @{varlist@} [BY @{varlist@} [BY @{varlist@} @dots{} ]]] ]
+ [ /@{@var{var_list}@}
+ [ BY @{@var{var_list}@} [BY @{@var{var_list}@} [BY @{@var{var_list}@} @dots{} ]]] ]
[/CELLS = [MEAN] [COUNT] [STDDEV] [SEMEAN] [SUM] [MIN] [MAX] [RANGE]
[VARIANCE] [KURT] [SEKURT]
The @subcmd{CELLS} subcommand specifies which statistics to calculate. The available statistics
are:
@itemize
-@item MEAN
+@item @subcmd{MEAN}
@cindex arithmetic mean
The arithmetic mean.
-@item COUNT
+@item @subcmd{COUNT}
The count of the values.
-@item STDDEV
+@item @subcmd{STDDEV}
The standard deviation.
-@item SEMEAN
+@item @subcmd{SEMEAN}
The standard error of the mean.
-@item SUM
+@item @subcmd{SUM}
The sum of the values.
-@item MIN
+@item @subcmd{MIN}
The minimum value.
-@item MAX
+@item @subcmd{MAX}
The maximum value.
-@item RANGE
+@item @subcmd{RANGE}
The difference between the maximum and minimum values.
-@item VARIANCE
+@item @subcmd{VARIANCE}
The variance.
-@item FIRST
+@item @subcmd{FIRST}
The first value in the category.
-@item LAST
+@item @subcmd{LAST}
The last value in the category.
-@item SKEW
+@item @subcmd{SKEW}
The skewness.
-@item SESKEW
+@item @subcmd{SESKEW}
The standard error of the skewness.
-@item KURT
+@item @subcmd{KURT}
The kurtosis
-@item SEKURT
+@item @subcmd{SEKURT}
The standard error of the kurtosis.
-@item HARMONIC
+@item @subcmd{HARMONIC}
@cindex harmonic mean
The harmonic mean.
-@item GEOMETRIC
+@item @subcmd{GEOMETRIC}
@cindex geometric mean
The geometric mean.
@end itemize
In addition, three special keywords are recognized:
@itemize
-@item DEFAULT
- This is the same as MEAN COUNT STDDEV
-@item ALL
+@item @subcmd{DEFAULT}
+ This is the same as @subcmd{MEAN} @subcmd{COUNT} @subcmd{STDDEV}.
+@item @subcmd{ALL}
All of the above statistics will be calculated.
-@item NONE
+@item @subcmd{NONE}
No statistics will be calculated (only a summary will be shown).
@end itemize
for any of the variables directly involved in their calculation are
encountered.
This behaviour can be modified with the @subcmd{/MISSING} subcommand.
-Three options are possible: TABLE, INCLUDE and DEPENDENT.
+Three options are possible: @subcmd{TABLE}, @subcmd{INCLUDE} and @subcmd{DEPENDENT}.
-/MISSING = TABLE causes cases to be dropped if any variable is missing
+@subcmd{/MISSING = TABLE} causes cases to be dropped if any variable is missing
in the table specification currently being processed, regardless of
whether it is needed to calculate the statistic.
-/MISSING = INCLUDE says that user missing values, either in the dependent
+@subcmd{/MISSING = INCLUDE} says that user missing values, either in the dependent
variables or in the categorical variables should be taken at their face
value, and not excluded.
-/MISSING = DEPENDENT says that user missing values, in the dependent
+@subcmd{/MISSING = DEPENDENT} says that user missing values, in the dependent
variables should be taken at their face value, however cases which
have user missing values for the categorical variables should be omitted
from the calculation.
[ /MISSING=@{ANALYSIS, LISTWISE@} @{INCLUDE, EXCLUDE@} ]
- [ /METHOD=EXACT [ TIMER [(n)] ] ]
+ [ /METHOD=EXACT [ TIMER [(@var{n})] ] ]
@end display
-NPAR TESTS performs nonparametric tests.
+@cmd{NPAR TESTS} performs nonparametric tests.
Non parametric tests make very few assumptions about the distribution of the
data.
One or more tests may be specified by using the corresponding subcommand.
Certain tests may take a long time to execute, if an exact figure is required.
Therefore, by default asymptotic approximations are used unless the
-subcommand /METHOD=EXACT is specified.
+subcommand @subcmd{/METHOD=EXACT} is specified.
Exact tests give more accurate results, but may take an unacceptably long
-time to perform. If the TIMER keyword is used, it sets a maximum time,
+time to perform. If the @subcmd{TIMER} keyword is used, it sets a maximum time,
after which the test will be abandoned, and a warning message printed.
-The time, in minutes, should be specified in parentheses after the TIMER keyword.
-If the TIMER keyword is given without this figure, then a default value of 5 minutes
+The time, in minutes, should be specified in parentheses after the @subcmd{TIMER} keyword.
+If the @subcmd{TIMER} keyword is given without this figure, then a default value of 5 minutes
is used.
@cindex binomial test
@display
- [ /BINOMIAL[(p)]=var_list[(value1[, value2)] ] ]
+ [ /BINOMIAL[(@var{p})]=@var{var_list}[(@var{value1}[, @var{value2})] ] ]
@end display
The @subcmd{/BINOMIAL} subcommand compares the observed distribution of a dichotomous
@display
- [ /CHISQUARE=var_list[(lo,hi)] [/EXPECTED=@{EQUAL|f1, f2 @dots{} fn@}] ]
+ [ /CHISQUARE=@var{var_list}[(@var{lo},@var{hi})] [/EXPECTED=@{EQUAL|@var{f1}, @var{f2} @dots{} @var{fn}@}] ]
@end display
The @subcmd{/EXPECTED} subcommand specifies the expected values of each
category.
There must be exactly one non-zero expected value, for each observed
-category, or the EQUAL keywork must be specified.
-You may use the notation @var{n}*@var{f} to specify @var{n}
+category, or the @subcmd{EQUAL} keywork must be specified.
+You may use the notation @subcmd{@var{n}*@var{f}} to specify @var{n}
consecutive expected categories all taking a frequency of @var{f}.
The frequencies given are proportions, not absolute frequencies. The
sum of the frequencies need not be 1.
@cindex Q, Cochran Q
@display
- [ /COCHRAN = varlist ]
+ [ /COCHRAN = @var{var_list} ]
@end display
The Cochran Q test is used to test for differences between three or more groups.
-The data for @var{varlist} in all cases must assume exactly two distinct values (other than missing values).
+The data for @var{var_list} in all cases must assume exactly two distinct values (other than missing values).
The value of Q will be displayed and its Asymptotic significance based on a chi-square distribution.
@cindex Friedman test
@display
- [ /FRIEDMAN = varlist ]
+ [ /FRIEDMAN = @var{var_list} ]
@end display
-The Friedman test is used to test for differences between repeated measures when there is no indication that the distributions are normally distributed.
+The Friedman test is used to test for differences between repeated measures when
+there is no indication that the distributions are normally distributed.
-A list of variables which contain the measured data must be given. The procedure prints the sum of ranks for each variable, the test statistic and its significance.
+A list of variables which contain the measured data must be given. The procedure
+prints the sum of ranks for each variable, the test statistic and its significance.
@node KENDALL
@subsection Kendall's W Test
@cindex coefficient of concordance
@display
- [ /KENDALL = varlist ]
+ [ /KENDALL = @var{var_list} ]
@end display
The Kendall test investigates whether an arbitrary number of related samples come from the
@cindex Kolmogorov-Smirnov test
@display
- [ /KOLMOGOROV-SMIRNOV (@{NORMAL [@var{mu}, @var{sigma}], UNIFORM [@var{min}, @var{max}], POISSON [@var{lambda}], EXPONENTIAL [@var{scale}] @}) = varlist ]
+ [ /KOLMOGOROV-SMIRNOV (@{NORMAL [@var{mu}, @var{sigma}], UNIFORM [@var{min}, @var{max}], POISSON [@var{lambda}], EXPONENTIAL [@var{scale}] @}) = @var{var_list} ]
@end display
The one sample Kolmogorov-Smirnov subcommand is used to test whether or not a dataset is
/KOLMOGOROV-SMIRNOV (normal 40 1.5) = @var{age}.
@end example
-The abbreviated subcommand K-S may be used in place of KOLMOGOROV-SMIRNOV.
+The abbreviated subcommand @subcmd{K-S} may be used in place of @subcmd{KOLMOGOROV-SMIRNOV}.
@node KRUSKAL-WALLIS
@subsection Kruskal-Wallis Test
@cindex Kruskal-Wallis test
@display
- [ /KRUSKAL-WALLIS = varlist BY var (lower, upper) ]
+ [ /KRUSKAL-WALLIS = @var{var_list} BY var (@var{lower}, @var{upper}) ]
@end display
The Kruskal-Wallis test is used to compare data from an
arbitrary number of populations. It does not assume normality.
-The data to be compared are specified by @var{varlist}.
+The data to be compared are specified by @var{var_list}.
The categorical variable determining the groups to which the
data belongs is given by @var{var}. The limits @var{lower} and
@var{upper} specify the valid range of @var{var}. Any cases for
The mean rank of each group as well as the chi-squared value and significance
of the test will be printed.
-The abbreviated subcommand K-W may be used in place of KRUSKAL-WALLIS.
+The abbreviated subcommand @subcmd{K-W} may be used in place of @subcmd{KRUSKAL-WALLIS}.
@node MANN-WHITNEY
@cindex U, Mann-Whitney U
@display
- [ /MANN-WHITNEY = varlist BY var (group1, group2) ]
+ [ /MANN-WHITNEY = @var{var_list} BY var (@var{group1}, @var{group2}) ]
@end display
The Mann-Whitney subcommand is used to test whether two groups of data come from different populations.
-The variables to be tested should be specified in @var{varlist} and the grouping variable, that determines to which group the test variables belong, in @var{var}.
+The variables to be tested should be specified in @var{var_list} and the grouping variable, that determines to which group the test variables belong, in @var{var}.
@var{Var} may be either a string or an alpha variable.
@var{Group1} and @var{group2} specify the
two values of @var{var} which determine the groups of the test data.
Cases for which the @var{var} value is neither @var{group1} or @var{group2} will be ignored.
The value of the Mann-Whitney U statistic, the Wilcoxon W, and the significance will be printed.
-The abbreviated subcommand M-W may be used in place of MANN-WHITNEY.
+The abbreviated subcommand @subcmd{M-W} may be used in place of @subcmd{MANN-WHITNEY}.
@node MCNEMAR
@subsection McNemar Test
@cindex McNemar test
@display
- [ /MCNEMAR varlist [ WITH varlist [ (PAIRED) ]]]
+ [ /MCNEMAR @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
@end display
Use McNemar's test to analyse the significance of the difference between
@cindex Median test
@display
- [ /MEDIAN [(value)] = varlist BY variable (value1, value2) ]
+ [ /MEDIAN [(@var{value})] = @var{var_list} BY @var{variable} (@var{value1}, @var{value2}) ]
@end display
The median test is used to test whether independent samples come from
@cindex runs test
@display
- [ /RUNS (@{MEAN, MEDIAN, MODE, value@}) = varlist ]
+ [ /RUNS (@{MEAN, MEDIAN, MODE, @var{value}@}) = @var{var_list} ]
@end display
The @subcmd{/RUNS} subcommand tests whether a data sequence is randomly ordered.
@cindex sign test
@display
- [ /SIGN varlist [ WITH varlist [ (PAIRED) ]]]
+ [ /SIGN @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
@end display
The @subcmd{/SIGN} subcommand tests for differences between medians of the
@node WILCOXON
@subsection Wilcoxon Matched Pairs Signed Ranks Test
-@comment node-name, next, previous, up
@vindex WILCOXON
@cindex wilcoxon matched pairs signed ranks test
@display
- [ /WILCOXON varlist [ WITH varlist [ (PAIRED) ]]]
+ [ /WILCOXON @var{var_list} [ WITH @var{var_list} [ (PAIRED) ]]]
@end display
The @subcmd{/WILCOXON} subcommand tests for differences between medians of the
The test does not make any assumptions about the variances of the samples.
It does however assume that the distribution is symetrical.
-If the @code{WITH} keyword is omitted, then tests for all
+If the @subcmd{WITH} keyword is omitted, then tests for all
combinations of the listed variables are performed.
-If the @code{WITH} keyword is given, and the @code{(PAIRED)} keyword
-is also given, then the number of variables preceding @code{WITH}
+If the @subcmd{WITH} keyword is given, and the @subcmd{(PAIRED)} keyword
+is also given, then the number of variables preceding @subcmd{WITH}
must be the same as the number following it.
In this case, tests for each respective pair of variables are
performed.
-If the @code{WITH} keyword is given, but the
-@code{(PAIRED)} keyword is omitted, then tests for each combination
-of variable preceding @code{WITH} against variable following
-@code{WITH} are performed.
+If the @subcmd{WITH} keyword is given, but the
+@subcmd{(PAIRED)} keyword is omitted, then tests for each combination
+of variable preceding @subcmd{WITH} against variable following
+@subcmd{WITH} are performed.
@node T-TEST
-@comment node-name, next, previous, up
@section T-TEST
@vindex T-TEST
@display
T-TEST
/MISSING=@{ANALYSIS,LISTWISE@} @{EXCLUDE,INCLUDE@}
- /CRITERIA=CIN(confidence)
+ /CRITERIA=CIN(@var{confidence})
(One Sample mode.)
- TESTVAL=test_value
- /VARIABLES=var_list
+ TESTVAL=@var{test_value}
+ /VARIABLES=@var{var_list}
(Independent Samples mode.)
- GROUPS=var(value1 [, value2])
- /VARIABLES=var_list
+ GROUPS=var(@var{value1} [, @var{value2}])
+ /VARIABLES=@var{var_list}
(Paired Samples mode.)
- PAIRS=var_list [WITH var_list [(PAIRED)] ]
+ PAIRS=@var{var_list} [WITH @var{var_list} [(PAIRED)] ]
@end display
The @cmd{MISSING} subcommand determines the handling of missing
variables.
-If INCLUDE is set, then user-missing values are included in the
+If @subcmd{INCLUDE} is set, then user-missing values are included in the
calculations, but system-missing values are not.
-If EXCLUDE is set, which is the default, user-missing
+If @subcmd{EXCLUDE} is set, which is the default, user-missing
values are excluded as well as system-missing values.
This is the default.
-If LISTWISE is set, then the entire case is excluded from analysis
-whenever any variable specified in the @cmd{/VARIABLES}, @cmd{/PAIRS} or
-@cmd{/GROUPS} subcommands contains a missing value.
-If ANALYSIS is set, then missing values are excluded only in the analysis for
+If @subcmd{LISTWISE} is set, then the entire case is excluded from analysis
+whenever any variable specified in the @subcmd{/VARIABLES}, @subcmd{/PAIRS} or
+@subcmd{/GROUPS} subcommands contains a missing value.
+If @subcmd{ANALYSIS} is set, then missing values are excluded only in the analysis for
which they would be needed. This is the default.
@node One Sample Mode
@subsection One Sample Mode
-The @cmd{TESTVAL} subcommand invokes the One Sample mode.
+The @subcmd{TESTVAL} subcommand invokes the One Sample mode.
This mode is used to test a population mean against a hypothesized
mean.
-The value given to the @cmd{TESTVAL} subcommand is the value against
+The value given to the @subcmd{TESTVAL} subcommand is the value against
which you wish to test.
-In this mode, you must also use the @cmd{/VARIABLES} subcommand to
+In this mode, you must also use the @subcmd{/VARIABLES} subcommand to
tell @pspp{} which variables you wish to test.
@node Independent Samples Mode
-@comment node-name, next, previous, up
@subsection Independent Samples Mode
The @subcmd{GROUPS} subcommand invokes Independent Samples mode or
@node Paired Samples Mode
-@comment node-name, next, previous, up
@subsection Paired Samples Mode
The @cmd{PAIRS} subcommand introduces Paired Samples mode.
Use this mode when repeated measures have been taken from the same
samples.
-If the @code{WITH} keyword is omitted, then tables for all
+If the @subcmd{WITH} keyword is omitted, then tables for all
combinations of variables given in the @cmd{PAIRS} subcommand are
generated.
-If the @code{WITH} keyword is given, and the @code{(PAIRED)} keyword
-is also given, then the number of variables preceding @code{WITH}
+If the @subcmd{WITH} keyword is given, and the @subcmd{(PAIRED)} keyword
+is also given, then the number of variables preceding @subcmd{WITH}
must be the same as the number following it.
In this case, tables for each respective pair of variables are
generated.
-In the event that the @code{WITH} keyword is given, but the
-@code{(PAIRED)} keyword is omitted, then tables for each combination
-of variable preceding @code{WITH} against variable following
-@code{WITH} are generated.
+In the event that the @subcmd{WITH} keyword is given, but the
+@subcmd{(PAIRED)} keyword is omitted, then tables for each combination
+of variable preceding @subcmd{WITH} against variable following
+@subcmd{WITH} are generated.
@node ONEWAY
-@comment node-name, next, previous, up
@section ONEWAY
@vindex ONEWAY
@display
ONEWAY
- [/VARIABLES = ] var_list BY var
+ [/VARIABLES = ] @var{var_list} BY @var{var}
/MISSING=@{ANALYSIS,LISTWISE@} @{EXCLUDE,INCLUDE@}
- /CONTRAST= value1 [, value2] ... [,valueN]
+ /CONTRAST= @var{value1} [, @var{value2}] ... [,@var{valueN}]
/STATISTICS=@{DESCRIPTIVES,HOMOGENEITY@}
- /POSTHOC=@{BONFERRONI, GH, LSD, SCHEFFE, SIDAK, TUKEY, ALPHA ([value])@}
+ /POSTHOC=@{BONFERRONI, GH, LSD, SCHEFFE, SIDAK, TUKEY, ALPHA ([@var{value}])@}
@end display
The @cmd{ONEWAY} procedure performs a one-way analysis of variance of
It is used to compare the means of a population
divided into more than two groups.
-The dependent variables to be analysed should be given in the @code{VARIABLES}
+The dependent variables to be analysed should be given in the @subcmd{VARIABLES}
subcommand.
-The list of variables must be followed by the @code{BY} keyword and
+The list of variables must be followed by the @subcmd{BY} keyword and
the name of the independent (or factor) variable.
-You can use the @code{STATISTICS} subcommand to tell @pspp{} to display
+You can use the @subcmd{STATISTICS} subcommand to tell @pspp{} to display
ancilliary information. The options accepted are:
@itemize
@item DESCRIPTIVES
variables and their groups.
@end itemize
-The @code{CONTRAST} subcommand is used when you anticipate certain
+The @subcmd{CONTRAST} subcommand is used when you anticipate certain
differences between the groups.
The subcommand must be followed by a list of numerals which are the
coefficients of the groups to be tested.
groups (or values of the independent variable).
If the total sum of the coefficients are not zero, then @pspp{} will
display a warning, but will proceed with the analysis.
-The @code{CONTRAST} subcommand may be given up to 10 times in order
+The @subcmd{CONTRAST} subcommand may be given up to 10 times in order
to specify different contrast tests.
The @subcmd{MISSING} subcommand defines how missing values are handled.
If @subcmd{LISTWISE} is specified then cases which have missing values for
the independent variable or any dependent variable will be ignored.
If @subcmd{ANALYSIS} is specified, then cases will be ignored if the independent
variable is missing or if the dependent variable currently being
-analysed is missing. The default is ANALYSIS.
-A setting of EXCLUDE means that variables whose values are
+analysed is missing. The default is @subcmd{ANALYSIS}.
+A setting of @subcmd{EXCLUDE} means that variables whose values are
user-missing are to be excluded from the analysis. A setting of
-INCLUDE means they are to be included. The default is EXCLUDE.
+@subcmd{INCLUDE} means they are to be included. The default is @subcmd{EXCLUDE}.
Using the @code{POSTHOC} subcommand you can perform multiple
pairwise comparisons on the data. The following comparison methods
are available:
@itemize
-@item LSD
+@item @subcmd{LSD}
Least Significant Difference.
-@item TUKEY
+@item @subcmd{TUKEY}
Tukey Honestly Significant Difference.
-@item BONFERRONI
+@item @subcmd{BONFERRONI}
Bonferroni test.
-@item SCHEFFE
+@item @subcmd{SCHEFFE}
Scheff@'e's test.
-@item SIDAK
+@item @subcmd{SIDAK}
Sidak test.
-@item GH
+@item @subcmd{GH}
The Games-Howell test.
@end itemize
The default is 0.05.
@node QUICK CLUSTER
-@comment node-name, next, previous, up
@section QUICK CLUSTER
@vindex QUICK CLUSTER
@cindex clustering
@display
-QUICK CLUSTER var_list
+QUICK CLUSTER @var{var_list}
[/CRITERIA=CLUSTERS(@var{k}) [MXITER(@var{max_iter})]]
[/MISSING=@{EXCLUDE,INCLUDE@} @{LISTWISE, PAIRWISE@}]
@end display
The minimum specification is @samp{QUICK CLUSTER} followed by the names
of the variables which contain the cluster data. Normally you will also
-want to specify @samp{/CRITERIA=CLUSTERS(@var{k})} where @var{k} is the
+want to specify @subcmd{/CRITERIA=CLUSTERS(@var{k})} where @var{k} is the
number of clusters. If this is not given, then @var{k} defaults to 2.
The command uses an iterative algorithm to determine the clusters for
each case. It will continue iterating until convergence, or until @var{max_iter}
iterations have been done. The default value of @var{max_iter} is 2.
-The @cmd{MISSING} subcommand determines the handling of missing variables.
-If INCLUDE is set, then user-missing values are considered at their face
+The @subcmd{MISSING} subcommand determines the handling of missing variables.
+If @subcmd{INCLUDE} is set, then user-missing values are considered at their face
value and not as missing values.
-If EXCLUDE is set, which is the default, user-missing
+If @subcmd{EXCLUDE} is set, which is the default, user-missing
values are excluded as well as system-missing values.
-If LISTWISE is set, then the entire case is excluded from the analysis
+If @subcmd{LISTWISE} is set, then the entire case is excluded from the analysis
whenever any of the clustering variables contains a missing value.
-If PAIRWISE is set, then a case is considered missing only if all the
+If @subcmd{PAIRWISE} is set, then a case is considered missing only if all the
clustering variables contain missing values. Otherwise it is clustered
on the basis of the non-missing values.
-The default is LISTWISE.
+The default is @subcmd{LISTWISE}.
@node RANK
-@comment node-name, next, previous, up
@section RANK
-
@vindex RANK
@display
RANK
- [VARIABLES=] var_list [@{A,D@}] [BY var_list]
+ [VARIABLES=] @var{var_list} [@{A,D@}] [BY @var{var_list}]
/TIES=@{MEAN,LOW,HIGH,CONDENSE@}
/FRACTION=@{BLOM,TUKEY,VW,RANKIT@}
/PRINT[=@{YES,NO@}
/MISSING=@{EXCLUDE,INCLUDE@}
- /RANK [INTO var_list]
- /NTILES(k) [INTO var_list]
- /NORMAL [INTO var_list]
- /PERCENT [INTO var_list]
- /RFRACTION [INTO var_list]
- /PROPORTION [INTO var_list]
- /N [INTO var_list]
- /SAVAGE [INTO var_list]
+ /RANK [INTO @var{var_list}]
+ /NTILES(k) [INTO @var{var_list}]
+ /NORMAL [INTO @var{var_list}]
+ /PERCENT [INTO @var{var_list}]
+ /RFRACTION [INTO @var{var_list}]
+ /PROPORTION [INTO @var{var_list}]
+ /N [INTO @var{var_list}]
+ /SAVAGE [INTO @var{var_list}]
@end display
The @cmd{RANK} command ranks variables and stores the results into new
The @subcmd{PRINT} subcommand may be used to specify that a summary of the rank
variables created should appear in the output.
-The function subcommands are RANK, NTILES, NORMAL, PERCENT, RFRACTION,
-PROPORTION and SAVAGE. Any number of function subcommands may appear.
+The function subcommands are @subcmd{RANK}, @subcmd{NTILES}, @subcmd{NORMAL}, @subcmd{PERCENT}, @subcmd{RFRACTION},
+@subcmd{PROPORTION} and @subcmd{SAVAGE}. Any number of function subcommands may appear.
If none are given, then the default is RANK.
The @subcmd{NTILES} subcommand must take an integer specifying the number of
partitions into which values should be ranked.
-Each subcommand may be followed by the INTO keyword and a list of
+Each subcommand may be followed by the @subcmd{INTO} keyword and a list of
variables which are the variables to be created and receive the rank
scores. There may be as many variables specified as there are
variables named on the @subcmd{VARIABLES} subcommand. If fewer are specified,
then the variable names are automatically created.
The @subcmd{MISSING} subcommand determines how user missing values are to be
-treated. A setting of EXCLUDE means that variables whose values are
+treated. A setting of @subcmd{EXCLUDE} means that variables whose values are
user-missing are to be excluded from the rank scores. A setting of
-INCLUDE means they are to be included. The default is EXCLUDE.
+@subcmd{INCLUDE} means they are to be included. The default is @subcmd{EXCLUDE}.
@include regression.texi
@vindex RELIABILITY
@display
RELIABILITY
- /VARIABLES=var_list
- /SCALE (@var{name}) = @{var_list, ALL@}
- /MODEL=@{ALPHA, SPLIT[(N)]@}
+ /VARIABLES=@var{var_list}
+ /SCALE (@var{name}) = @{@var{var_list}, ALL@}
+ /MODEL=@{ALPHA, SPLIT[(@var{n})]@}
/SUMMARY=@{TOTAL,ALL@}
/MISSING=@{EXCLUDE,INCLUDE@}
@end display
Optionally, the @var{name} parameter may be specified to set a string name
for the scale.
-The @subcmd{MODEL} subcommand determines the type of analysis. If ALPHA is specified,
-then Cronbach's Alpha is calculated for the scale. If the model is SPLIT,
+The @subcmd{MODEL} subcommand determines the type of analysis. If @subcmd{ALPHA} is specified,
+then Cronbach's Alpha is calculated for the scale. If the model is @subcmd{SPLIT},
then the variables are divided into 2 subsets. An optional parameter
-@var{N} may be given, to specify how many variables to be in the first subset.
-If @var{N} is omitted, then it defaults to one half of the variables in the
+@var{n} may be given, to specify how many variables to be in the first subset.
+If @var{n} is omitted, then it defaults to one half of the variables in the
scale, or one half minus one if there are an odd number of variables.
-The default model is ALPHA.
+The default model is @subcmd{ALPHA}.
By default, any cases with user missing, or system missing values for
any variables given
be included or excluded in the analysis.
The @subcmd{SUMMARY} subcommand determines the type of summary analysis to be performed.
-Currently there is only one type: SUMMARY=TOTAL, which displays per-item
+Currently there is only one type: @subcmd{SUMMARY=TOTAL}, which displays per-item
analysis tested against the totals.
The variable @var{state_var} is the variable whose values represent the actual states,
and @var{state_value} is the value of this variable which represents the positive state.
-The optional subcommand PLOT is used to determine if and how the ROC curve is drawn.
-The keyword CURVE means that the ROC curve should be drawn, and the optional keyword REFERENCE,
+The optional subcommand @subcmd{PLOT} is used to determine if and how the @subcmd{ROC} curve is drawn.
+The keyword @subcmd{CURVE} means that the @subcmd{ROC} curve should be drawn, and the optional keyword @subcmd{REFERENCE},
which should be enclosed in parentheses, says that the diagonal reference line should be drawn.
-If the keyword NONE is given, then no ROC curve is drawn.
+If the keyword @subcmd{NONE} is given, then no @subcmd{ROC} curve is drawn.
By default, the curve is drawn with no reference line.
-The optional subcommand PRINT determines which additional tables should be printed.
+The optional subcommand @subcmd{PRINT} determines which additional tables should be printed.
Two additional tables are available.
-The SE keyword says that standard error of the area under the curve should be printed as well as
+The @subcmd{SE} keyword says that standard error of the area under the curve should be printed as well as
the area itself.
In addition, a p-value under the null hypothesis that the area under the curve equals 0.5 will be
printed.
-The COORDINATES keyword says that a table of coordinates of the ROC curve should be printed.
+The @subcmd{COORDINATES} keyword says that a table of coordinates of the @subcmd{ROC} curve should be printed.
The @subcmd{CRITERIA} subcommand has four optional parameters:
@itemize @bullet
-@item The TESTPOS parameter may be LARGE or SMALL.
-LARGE is the default, and says that larger values in the predictor variables are to be
-considered positive. SMALL indicates that smaller values should be considered positive.
+@item The @subcmd{TESTPOS} parameter may be @subcmd{LARGE} or @subcmd{SMALL}.
+@subcmd{LARGE} is the default, and says that larger values in the predictor variables are to be
+considered positive. @subcmd{SMALL} indicates that smaller values should be considered positive.
-@item The CI parameter specifies the confidence interval that should be printed.
-It has no effect if the SE keyword in the @subcmd{PRINT} subcommand has not been given.
+@item The @subcmd{CI} parameter specifies the confidence interval that should be printed.
+It has no effect if the @subcmd{SE} keyword in the @subcmd{PRINT} subcommand has not been given.
-@item The DISTRIBUTION parameter determines the method to be used when estimating the area
+@item The @subcmd{DISTRIBUTION} parameter determines the method to be used when estimating the area
under the curve.
-There are two possibilities, @i{viz}: FREE and NEGEXPO.
-The FREE method uses a non-parametric estimate, and the NEGEXPO method a bi-negative
+There are two possibilities, @i{viz}: @subcmd{FREE} and @subcmd{NEGEXPO}.
+The @subcmd{FREE} method uses a non-parametric estimate, and the @subcmd{NEGEXPO} method a bi-negative
exponential distribution estimate.
-The NEGEXPO method should only be used when the number of positive actual states is
+The @subcmd{NEGEXPO} method should only be used when the number of positive actual states is
equal to the number of negative actual states.
-The default is FREE.
+The default is @subcmd{FREE}.
-@item The CUTOFF parameter is for compatibility and is ignored.
+@item The @subcmd{CUTOFF} parameter is for compatibility and is ignored.
@end itemize
The @subcmd{MISSING} subcommand determines whether user missing values are to
@display
AGGREGATE
- OUTFILE=@{*,'file-name',file_handle@} [MODE=@{REPLACE, ADDVARIABLES@}]
+ OUTFILE=@{*,'@var{file_name}',@var{file_handle}@} [MODE=@{REPLACE, ADDVARIABLES@}]
/PRESORTED
/DOCUMENT
/MISSING=COLUMNWISE
- /BREAK=var_list
- /dest_var['label']@dots{}=agr_func(src_vars, args@dots{})@dots{}
+ /BREAK=@var{var_list}
+ /@var{dest_var}['@var{label}']@dots{}=@var{agr_func}(@var{src_vars}, @var{args}@dots{})@dots{}
@end display
@cmd{AGGREGATE} summarizes groups of cases into single cases.
If OUTFILE=@samp{*} is given, then the subcommand MODE may also be
specified.
-The mode subcommand has two possible values: ADDVARIABLES or REPLACE.
-In REPLACE mode, the entire active dataset is replaced by a new dataset
+The mode subcommand has two possible values: @subcmd{ADDVARIABLES} or @subcmd{REPLACE}.
+In @subcmd{REPLACE} mode, the entire active dataset is replaced by a new dataset
which contains just the break variables and the destination varibles.
In this mode, the new file will contain as many cases as there are
unique combinations of the break variables.
-In ADDVARIABLES mode, the destination variables will be appended to
+In @subcmd{ADDVARIABLES} mode, the destination variables will be appended to
the existing active dataset.
Cases which have identical combinations of values in their break
variables, will receive identical values for the destination variables.
The number of cases in the active dataset will remain unchanged.
-Note that if ADDVARIABLES is specified, then the data @emph{must} be
+Note that if @subcmd{ADDVARIABLES} is specified, then the data @emph{must} be
sorted on the break variables.
By default, the active dataset will be sorted based on the break variables
before aggregation takes place. If the active dataset is already sorted
or otherwise grouped in terms of the break variables, specify
-PRESORTED to save time.
-PRESORTED is assumed if MODE=ADDVARIABLES is used.
+@subcmd{PRESORTED} to save time.
+@subcmd{PRESORTED} is assumed if @subcmd{MODE=ADDVARIABLES} is used.
-Specify DOCUMENT to copy the documents from the active dataset into the
+Specify @subcmd{DOCUMENT} to copy the documents from the active dataset into the
aggregate file (@pxref{DOCUMENT}). Otherwise, the aggregate file will
not contain any documents, even if the aggregate file replaces the
active dataset.
-Normally, only a single case (for SD and SD., two cases) need be
+Normally, only a single case (for @subcmd{SD} and @subcmd{SD}., two cases) need be
non-missing in each group for the aggregate variable to be
-non-missing. Specifying /MISSING=COLUMNWISE inverts this behavior, so
+non-missing. Specifying @subcmd{/MISSING=COLUMNWISE} inverts this behavior, so
that the aggregate variable becomes missing if any aggregated value is
missing.
-If PRESORTED, DOCUMENT, or MISSING are specified, they must appear
-between OUTFILE and BREAK.
+If @subcmd{PRESORTED}, @subcmd{DOCUMENT}, or @subcmd{MISSING} are specified, they must appear
+between @subcmd{OUTFILE} and @subcmd{BREAK}.
-At least one break variable must be specified on BREAK, a
+At least one break variable must be specified on @subcmd{BREAK}, a
required subcommand. The values of these variables are used to divide
the active dataset into groups to be summarized. In addition, at least
one @var{dest_var} must be specified.
The available aggregation functions are as follows:
@table @asis
-@item FGT(var_name, value)
+@item FGT(@var{var_name}, @var{value})
Fraction of values greater than the specified constant. The default
format is F5.3.
-@item FIN(var_name, low, high)
+@item FIN(@var{var_name}, @var{low}, @var{high})
Fraction of values within the specified inclusive range of constants.
The default format is F5.3.
-@item FLT(var_name, value)
+@item FLT(@var{var_name}, @var{value})
Fraction of values less than the specified constant. The default
format is F5.3.
-@item FIRST(var_name)
+@item FIRST(@var{var_name})
First non-missing value in break group. The aggregation variable
receives the complete dictionary information from the source variable.
-The sort performed by AGGREGATE (and by SORT CASES) is stable, so that
+The sort performed by @cmd{AGGREGATE} (and by @cmd{SORT CASES}) is stable, so that
the first case with particular values for the break variables before
sorting will also be the first case in that break group after sorting.
-@item FOUT(var_name, low, high)
+@item FOUT(@var{var_name}, @var{low}, @var{high})
Fraction of values strictly outside the specified range of constants.
The default format is F5.3.
-@item LAST(var_name)
+@item LAST(@var{var_name})
Last non-missing value in break group. The aggregation variable
receives the complete dictionary information from the source variable.
-The sort performed by AGGREGATE (and by SORT CASES) is stable, so that
+The sort performed by @cmd{AGGREGATE} (and by @cmd{SORT CASES}) is stable, so that
the last case with particular values for the break variables before
sorting will also be the last case in that break group after sorting.
-@item MAX(var_name)
+@item MAX(@var{var_name})
Maximum value. The aggregation variable receives the complete
dictionary information from the source variable.
-@item MEAN(var_name)
+@item MEAN(@var{var_name})
Arithmetic mean. Limited to numeric values. The default format is
F8.2.
-@item MEDIAN(var_name)
+@item MEDIAN(@var{var_name})
The median value. Limited to numeric values. The default format is F8.2.
-@item MIN(var_name)
+@item MIN(@var{var_name})
Minimum value. The aggregation variable receives the complete
dictionary information from the source variable.
-@item N(var_name)
+@item N(@var{var_name})
Number of non-missing values. The default format is F7.0 if weighting
is not enabled, F8.2 if it is (@pxref{WEIGHT}).
Number of cases aggregated to form this group. The default format is
F7.0 if weighting is not enabled, F8.2 if it is (@pxref{WEIGHT}).
-@item NMISS(var_name)
+@item NMISS(@var{var_name})
Number of missing values. The default format is F7.0 if weighting is
not enabled, F8.2 if it is (@pxref{WEIGHT}).
-@item NU(var_name)
+@item NU(@var{var_name})
Number of non-missing values. Each case is considered to have a weight
of 1, regardless of the current weighting variable (@pxref{WEIGHT}).
The default format is F7.0.
to have a weight of 1, regardless of the current weighting variable.
The default format is F7.0.
-@item NUMISS(var_name)
+@item NUMISS(@var{var_name})
Number of missing values. Each case is considered to have a weight of
1, regardless of the current weighting variable. The default format is F7.0.
-@item PGT(var_name, value)
+@item PGT(@var{var_name}, @var{value})
Percentage between 0 and 100 of values greater than the specified
constant. The default format is F5.1.
-@item PIN(var_name, low, high)
+@item PIN(@var{var_name}, @var{low}, @var{high})
Percentage of values within the specified inclusive range of
constants. The default format is F5.1.
-@item PLT(var_name, value)
+@item PLT(@var{var_name}, @var{value})
Percentage of values less than the specified constant. The default
format is F5.1.
-@item POUT(var_name, low, high)
+@item POUT(@var{var_name}, @var{low}, @var{high})
Percentage of values strictly outside the specified range of
constants. The default format is F5.1.
-@item SD(var_name)
+@item SD(@var{var_name})
Standard deviation of the mean. Limited to numeric values. The
default format is F8.2.
@vindex AUTORECODE
@display
-AUTORECODE VARIABLES=src_vars INTO dest_vars
+AUTORECODE VARIABLES=@var{src_vars} INTO @var{dest_vars}
[ /DESCENDING ]
[ /PRINT ]
[ /GROUP ]
takes on and maps them onto values 1@dots{}@var{n} on a new numeric
variable.
-Subcommand VARIABLES is the only required subcommand and must come
-first. Specify VARIABLES, an equals sign (@samp{=}), a list of source
-variables, INTO, and a list of target variables. There must the same
+Subcommand @subcmd{VARIABLES} is the only required subcommand and must come
+first. Specify @subcmd{VARIABLES}, an equals sign (@samp{=}), a list of source
+variables, @subcmd{INTO}, and a list of target variables. There must the same
number of source and target variables. The target variables must not
already exist.
@vindex COMPUTE
@display
-COMPUTE variable = expression.
+COMPUTE @var{variable} = @var{expression}.
+@end display
or
-COMPUTE vector(index) = expression.
+@display
+COMPUTE vector(@var{index}) = @var{expression}.
@end display
@cmd{COMPUTE} assigns the value of an expression to a target
they can be used as targets for @cmd{COMPUTE}.
The target variable may be specified as an element of a vector
-(@pxref{VECTOR}). In this case, a vector index expression must be
-specified in parentheses following the vector name. The index
-expression must evaluate to a numeric value that, after rounding down
+(@pxref{VECTOR}). In this case, an expression @var{index} must be
+specified in parentheses following the vector name. The expression @var{index}
+must evaluate to a numeric value that, after rounding down
to the nearest integer, is a valid index for the named vector.
Using @cmd{COMPUTE} to assign to a variable specified on @cmd{LEAVE}
@vindex COUNT
@display
-COUNT var_name = var@dots{} (value@dots{}).
+COUNT @var{var_name} = @var{var}@dots{} (@var{value}@dots{}).
-Each value takes one of the following forms:
- number
- string
- num1 THRU num2
+Each @var{value} takes one of the following forms:
+ @var{number}
+ @var{string}
+ @var{num1} THRU @var{num2}
MISSING
SYSMIS
-In addition, num1 and num2 can be LO or LOWEST, or HI or HIGHEST,
+In addition, @var{num1} and @var{num2} can be LO or LOWEST, or HI or HIGHEST,
respectively.
@end display
and user-missing values.
@cmd{COUNT} target variables are assigned values in the order
-specified. In the command @code{COUNT A=A B(1) /B=A B(2).}, the
+specified. In the command @code{COUNT @var{A}=@var{A} @var{B}(1) /@var{B}=@var{A} @var{B}(2).}, the
following actions occur:
@itemize @minus
@item
-The number of occurrences of 1 between @code{A} and @code{B} is counted.
+The number of occurrences of 1 between @var{A} and @var{B} is counted.
@item
-@code{A} is assigned this value.
+@var{A} is assigned this value.
@item
-The number of occurrences of 1 between @code{B} and the @strong{new}
-value of @code{A} is counted.
+The number of occurrences of 1 between @var{B} and the @strong{new}
+value of @var{A} is counted.
@item
-@code{B} is assigned this value.
+@var{B} is assigned this value.
@end itemize
Despite this ordering, all @cmd{COUNT} criterion variables must exist
@vindex FLIP
@display
-FLIP /VARIABLES=var_list /NEWNAMES=var_name.
+FLIP /VARIABLES=@var{var_list} /NEWNAMES=@var{var_name}.
@end display
@cmd{FLIP} transposes rows and columns in the active dataset. It
specified are discarded. If the @subcmd{VARIABLES} subcommand is omitted, all
variables are selected for transposition.
-The variables specified by NEWNAMES, which must be a string variable, is
+The variables specified by @subcmd{NEWNAMES}, which must be a
+string variable, is
used to give names to the variables created by @cmd{FLIP}. Only the
first 8 characters of the variable are used. If
-NEWNAMES is not
+@subcmd{NEWNAMES} is not
specified then the default is a variable named CASE_LBL, if it exists.
-If it does not then the variables created by FLIP are named VAR000
+If it does not then the variables created by @cmd{FLIP} are named VAR000
through VAR999, then VAR1000, VAR1001, and so on.
-When a NEWNAMES variable is available, the names must be canonicalized
+When a @subcmd{NEWNAMES} variable is available, the names must be canonicalized
before becoming variable names. Invalid characters are replaced by
letter @samp{V} in the first position, or by @samp{_} in subsequent
positions. If the name thus generated is not unique, then numeric
extensions are added, starting with 1, until a unique name is found or
there are no remaining possibilities. If the latter occurs then the
-FLIP operation aborts.
+@cmd{FLIP} operation aborts.
The resultant dictionary contains a CASE_LBL variable, a string
variable of width 8, which stores the names of the variables in the
transposed using @cmd{FLIP}, this variable can be used to recreate the
original variable names.
-FLIP honors @cmd{N OF CASES} (@pxref{N OF CASES}). It ignores
+@cmd{FLIP} honors @cmd{N OF CASES} (@pxref{N OF CASES}). It ignores
@cmd{TEMPORARY} (@pxref{TEMPORARY}), so that ``temporary''
transformations become permanent.
@vindex IF
@display
-IF condition variable=expression.
+IF @var{condition} @var{variable}=@var{expression}.
+@end display
or
-IF condition vector(index)=expression.
+@display
+IF @var{condition} vector(@var{index})=@var{expression}.
@end display
The @cmd{IF} transformation conditionally assigns the value of a target
expression.
Specify a boolean-valued expression (@pxref{Expressions}) to be tested
-following the IF keyword. This expression is evaluated for each case.
+following the @cmd{IF} keyword. This expression is evaluated for each case.
If the value is true, then the value of the expression is computed and
assigned to the specified variable. If the value is false or missing,
nothing is done. Numeric and string variables may be
@vindex SORT CASES
@display
-SORT CASES BY var_list[(@{D|A@}] [ var_list[(@{D|A@}] ] ...
+SORT CASES BY @var{var_list}[(@{D|A@}] [ @var{var_list}[(@{D|A@}] ] ...
@end display
@cmd{SORT CASES} sorts the active dataset by the values of one or more
variables.
-Specify BY and a list of variables to sort by. By default, variables
-are sorted in ascending order. To override sort order, specify (D) or
-(DOWN) after a list of variables to get descending order, or (A) or (UP)
+Specify @subcmd{BY} and a list of variables to sort by. By default, variables
+are sorted in ascending order. To override sort order, specify @subcmd{(D)} or
+@subcmd{(DOWN)} after a list of variables to get descending order, or @subcmd{(A)} or @subcmd{(UP)}
for ascending order. These apply to all the listed variables
-up until the preceding (A), (D), (UP) or (DOWN).
+up until the preceding @subcmd{(A)}, @subcmd{(D)}, @subcmd{(UP)} or @subcmd{(DOWN)}.
The sort algorithms used by @cmd{SORT CASES} are stable. That is,
records that have equal values of the sort variables will have the
If workspace is exhausted, it falls back to a merge sort algorithm that
involves creates numerous temporary files.
-@cmd{SORT CASES} may not be specified following TEMPORARY.
+@cmd{SORT CASES} may not be specified following @cmd{TEMPORARY}.
Whichever method you choose, the syntax is identical.
When using the interactive method, @pspp{} tells you that it's waiting for your
-data with a string like @prompt{@pspp{}>} or @prompt{data>}.
+data with a string like @prompt{PSPP>} or @prompt{data>}.
In the examples of this chapter, whenever you see text like this, it
indicates the prompt displayed by @pspp{}, @emph{not} something that you
should type.
@float Example, data-list
@cartouche
@example
-@prompt{@pspp{}>} data list list /forename (A12) height.
-@prompt{@pspp{}>} begin data.
+@prompt{PSPP>} data list list /forename (A12) height.
+@prompt{PSPP>} begin data.
@prompt{data>} Ahmed 188
@prompt{data>} Bertram 167
@prompt{data>} Catherine 134.231
@prompt{data>} David 109.1
@prompt{data>} end data
-@prompt{@pspp{}>}
+@prompt{PSPP>}
@end example
@end cartouche
@caption{Manual entry of data using the @cmd{DATA LIST} command.
@item
-Normally, @pspp{} displays the prompt @prompt{@pspp{}>} whenever it's
+Normally, @pspp{} displays the prompt @prompt{PSPP>} whenever it's
expecting a command.
However, when it's expecting data, the prompt changes to @prompt{data>}
so that you know to enter data and not a command.
Once the data has been entered,
you could type
@example
-@prompt{@pspp{}>} list /format=numbered.
+@prompt{PSPP>} list /format=numbered.
@end example
@noindent
to list the data.
You can can tell the @cmd{DATA LIST} command to read the data directly from
this file instead of by manual entry, with a command like:
@example
-@prompt{@pspp{}>} data list file='mydata.dat' list /forename (A12) height.
+@prompt{PSPP>} data list file='mydata.dat' list /forename (A12) height.
@end example
@noindent
Notice however, that it is still necessary to specify the names of the
not mandatory.
The following syntax loads a file called @file{my-file.sav}.
@example
-@prompt{@pspp{}>} get file='my-file.sav'.
+@prompt{PSPP>} get file='my-file.sav'.
@end example
@noindent
You will encounter several instances of this in future examples.
The following syntax will save the existing data and variables to a
file called @file{my-new-file.sav}.
@example
-@prompt{@pspp{}>} save outfile='my-new-file.sav'.
+@prompt{PSPP>} save outfile='my-new-file.sav'.
@end example
@noindent
If @file{my-new-file.sav} already exists, then it will be overwritten.
@float Example, descriptives
@cartouche
@example
-@prompt{@pspp{}>} get file='@value{example-dir}/physiology.sav'.
-@prompt{@pspp{}>} descriptives sex, weight, height.
+@prompt{PSPP>} get file='@value{example-dir}/physiology.sav'.
+@prompt{PSPP>} descriptives sex, weight, height.
@end example
Output:
@cartouche
[@dots{} continue from @ref{descriptives}]
@example
-@prompt{@pspp{}>} examine height, weight /statistics=extreme(3).
+@prompt{PSPP>} examine height, weight /statistics=extreme(3).
@end example
Output:
@float Example, reliability
@cartouche
@example
-@prompt{@pspp{}>} get file='@value{example-dir}/hotel.sav'.
-@prompt{@pspp{}>} display dictionary.
-@prompt{@pspp{}>} * recode negatively worded questions.
-@prompt{@pspp{}>} compute v3 = 6 - v3.
-@prompt{@pspp{}>} compute v5 = 6 - v5.
-@prompt{@pspp{}>} reliability v1, v3, v5.
+@prompt{PSPP>} get file='@value{example-dir}/hotel.sav'.
+@prompt{PSPP>} display dictionary.
+@prompt{PSPP>} * recode negatively worded questions.
+@prompt{PSPP>} compute v3 = 6 - v3.
+@prompt{PSPP>} compute v5 = 6 - v5.
+@prompt{PSPP>} reliability v1, v3, v5.
@end example
Output (dictionary information omitted for clarity):
@float Example, normality
@cartouche
@example
-@prompt{@pspp{}>} get file='@value{example-dir}/repairs.sav'.
-@prompt{@pspp{}>} examine mtbf
+@prompt{PSPP>} get file='@value{example-dir}/repairs.sav'.
+@prompt{PSPP>} examine mtbf
/statistics=descriptives.
-@prompt{@pspp{}>} compute mtbf_ln = ln (mtbf).
-@prompt{@pspp{}>} examine mtbf_ln
+@prompt{PSPP>} compute mtbf_ln = ln (mtbf).
+@prompt{PSPP>} examine mtbf_ln
/statistics=descriptives.
@end example
@float Example, t-test
@cartouche
@example
-@prompt{@pspp{}>} get file='@value{example-dir}/physiology.sav'.
-@prompt{@pspp{}>} recode height (179 = SYSMIS).
-@prompt{@pspp{}>} t-test group=sex(0,1) /variables = height temperature.
+@prompt{PSPP>} get file='@value{example-dir}/physiology.sav'.
+@prompt{PSPP>} recode height (179 = SYSMIS).
+@prompt{PSPP>} t-test group=sex(0,1) /variables = height temperature.
@end example
Output:
@example
@float Example, regression
@cartouche
@example
-@prompt{@pspp{}>} get file='@value{example-dir}/repairs.sav'.
-@prompt{@pspp{}>} regression /variables = mtbf duty_cycle /dependent = mttr.
-@prompt{@pspp{}>} regression /variables = mtbf /dependent = mttr.
+@prompt{PSPP>} get file='@value{example-dir}/repairs.sav'.
+@prompt{PSPP>} regression /variables = mtbf duty_cycle /dependent = mttr.
+@prompt{PSPP>} regression /variables = mtbf /dependent = mttr.
@end example
Output:
@example
predictor of the time to repair.
-@c LocalWords: @pspp{} dir itemize noindent var cindex dfn cartouche samp xref
+@c LocalWords: PSPP dir itemize noindent var cindex dfn cartouche samp xref
@c LocalWords: pxref ie sav Std Dev kilograms SYSMIS sansserif pre pspp emph
@c LocalWords: Likert Cronbach's Cronbach mtbf npplot ln myfile cmd NPAR Sig
@c LocalWords: vindex Levene Levene's df Diff clicksequence mydata dat ascii
@end menu
@node ADD DOCUMENT
-@comment node-name, next, previous, up
@section ADD DOCUMENT
@vindex ADD DOCUMENT
Use @cmd{ECHO} to write arbitrary text to the output stream. The text should be enclosed in quotation marks following the normal rules for string tokens (@pxref{Tokens}).
@node ERASE
-@comment node-name, next, previous, up
@section ERASE
@vindex ERASE
@cmd{ERASE FILE} deletes a file from the local filesystem.
file_name must be quoted.
-This command cannot be used if the SAFER setting is active.
+This command cannot be used if the SAFER (@pxref{SET}) setting is active.
@node EXECUTE
@vindex FILE LABEL
@display
-FILE LABEL file_label.
+FILE LABEL @var{file_label}.
@end display
@cmd{FILE LABEL} provides a title for the active dataset. This
title will be saved into system files and portable files that are
created during this @pspp{} run.
-file_label need not be quoted. If quotes are
-included, they become part of the file label.
+@var{file_label} should not be quoted.
+If quotes are included, they are literally interpreted and become part of the file label.
@node FINISH
@section FINISH
control to the operating system.
@node HOST
-@comment node-name, next, previous, up
@section HOST
@vindex HOST
@display
HOST.
-HOST COMMAND=['command'...].
+HOST COMMAND=['@var{command}'...].
@end display
@cmd{HOST} suspends the current @pspp{} session and temporarily returns control
to the operating system.
-This command cannot be used if the SAFER setting is active.
+This command cannot be used if the SAFER (@pxref{SET}) setting is active.
If the @subcmd{COMMAND} subcommand is specified, as a sequence of shell
commands as quoted strings within square brackets, then @pspp{} executes
@vindex INCLUDE
@display
- INCLUDE [FILE=]'file-name' [ENCODING='encoding'].
+ INCLUDE [FILE=]'@var{file_name}' [ENCODING='@var{encoding}'].
@end display
@cmd{INCLUDE} causes the @pspp{} command processor to read an
memory.
The @cmd{INSERT} command (@pxref{INSERT}) is a more flexible
-alternative to @cmd{INCLUDE}. An INCLUDE command acts the same as
-INSERT with ERROR=STOP CD=NO SYNTAX=BATCH specified.
+alternative to @cmd{INCLUDE}. An @cmd{INCLUDE} command acts the same as
+@cmd{INSERT} with @subcmd{ERROR=STOP CD=NO SYNTAX=BATCH} specified.
-The optional @subcmd{ENCODING} subcommand has the same meaning as on INSERT.
+The optional @subcmd{ENCODING} subcommand has the same meaning as with @cmd{INSERT}.
@node INSERT
@section INSERT
@vindex INSERT
@display
- INSERT [FILE=]'file-name'
+ INSERT [FILE=]'@var{file_name}'
[CD=@{NO,YES@}]
[ERROR=@{CONTINUE,STOP@}]
[SYNTAX=@{BATCH,INTERACTIVE@}]
- [ENCODING='encoding'].
+ [ENCODING=@{LOCALE, '@var{charset_name}'@}].
@end display
@cmd{INSERT} is similar to @cmd{INCLUDE} (@pxref{INCLUDE})
It causes the command processor to read a file as if it were embedded in the
current command file.
-If @samp{CD=YES} is specified, then before including the file, the
+If @subcmd{CD=YES} is specified, then before including the file, the
current directory will be changed to the directory of the included
file.
The default setting is @samp{CD=NO}.
It will not revert to its original setting even after the included
file is finished processing.
-If @samp{ERROR=STOP} is specified, errors encountered in the
+If @subcmd{ERROR=STOP} is specified, errors encountered in the
inserted file will cause processing to immediately cease.
Otherwise processing will continue at the next command.
-The default setting is @samp{ERROR=CONTINUE}.
+The default setting is @subcmd{ERROR=CONTINUE}.
-If @samp{SYNTAX=INTERACTIVE} is specified then the syntax contained in
+If @subcmd{SYNTAX=INTERACTIVE} is specified then the syntax contained in
the included file must conform to interactive syntax
conventions. @xref{Syntax Variants}.
-The default setting is @samp{SYNTAX=BATCH}.
+The default setting is @subcmd{SYNTAX=BATCH}.
-ENCODING optionally specifies the character set used by the included
+@subcmd{ENCODING} optionally specifies the character set used by the included
file. Its argument, which is not case-sensitive, must be in one of
the following forms:
@table @asis
-@item @code{Locale}
-The encoding used by the system locale, or as overridden by the SET
-LOCALE command (@pxref{SET}). On Unix systems, environment variables,
-e.g.@: @env{LANG} or @env{LC_ALL}, determine the system locale.
+@item @subcmd{LOCALE}
+The encoding used by the system locale, or as overridden by the
+@cmd{SET} command (@pxref{SET}). On GNU/Linux and other Unix-like systems,
+environment variables, e.g.@: @env{LANG} or @env{LC_ALL}, determine the
+system locale.
-@item IANA character set name
+@item @var{charset_name}
One of the character set names listed by IANA at
@uref{http://www.iana.org/assignments/character-sets}. Some examples
are @code{ASCII} (United States), @code{ISO-8859-1} (western Europe),
@display
PERMISSIONS
- FILE='file-name'
+ FILE='@var{file_name}'
/PERMISSIONS = @{READONLY,WRITEABLE@}.
@end display
@cmd{PERMISSIONS} changes the permissions of a file.
There is one mandatory subcommand which specifies the permissions to
which the file should be changed.
-If you set a file's permission to READONLY, then the file will become
+If you set a file's permission to @subcmd{READONLY}, then the file will become
unwritable either by you or anyone else on the system.
-If you set the permission to WRITEABLE, then the file will become
+If you set the permission to @subcmd{WRITEABLE}, then the file will become
writeable by you; the permissions afforded to others will be
unchanged.
-This command cannot be used if the SAFER setting is active.
+This command cannot be used if the @subcmd{SAFER} (@pxref{SET}) setting is active.
@node PRESERVE and RESTORE
(data input)
/BLANKS=@{SYSMIS,'.',number@}
/DECIMAL=@{DOT,COMMA@}
- /FORMAT=fmt_spec
- /EPOCH=@{AUTOMATIC,year@}
+ /FORMAT=@var{fmt_spec}
+ /EPOCH=@{AUTOMATIC,@var{year}@}
/RIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
/RRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
(interaction)
- /MXERRS=max_errs
- /MXWARNS=max_warnings
- /WORKSPACE=workspace_size
+ /MXERRS=@var{max_errs}
+ /MXWARNS=@var{max_warnings}
+ /WORKSPACE=@var{workspace_size}
(syntax execution)
- /LOCALE='locale'
+ /LOCALE='@var{locale}'
/MEXPAND=@{ON,OFF@}
- /MITERATE=max_iterations
- /MNEST=max_nest
+ /MITERATE=@var{max_iterations}
+ /MNEST=@var{max_nest}
/MPRINT=@{ON,OFF@}
- /MXLOOPS=max_loops
- /SEED=@{RANDOM,seed_value@}
+ /MXLOOPS=@var{max_loops}
+ /SEED=@{RANDOM,@var{seed_value}@}
/UNDEFINED=@{WARN,NOWARN@}
(data output)
- /CC@{A,B,C,D,E@}=@{'npre,pre,suf,nsuf','npre.pre.suf.nsuf'@}
+ /CC@{A,B,C,D,E@}=@{'@var{npre},@var{pre},@var{suf},@var{nsuf}','@var{npre}.@var{pre}.@var{suf}.@var{nsuf}'@}
/DECIMAL=@{DOT,COMMA@}
- /FORMAT=fmt_spec
+ /FORMAT=@var{fmt_spec}
/WIB=@{NATIVE,MSBFIRST,LSBFIRST,VAX@}
/WRB=@{NATIVE,ISL,ISB,IDL,IDB,VF,VD,VG,ZS,ZL@}
(output driver options)
/HEADERS=@{NO,YES,BLANK@}
- /LENGTH=@{NONE,length_in_lines@}
+ /LENGTH=@{NONE,@var{n_lines}@}
/MORE=@{ON,OFF@}
- /WIDTH=@{NARROW,WIDTH,n_characters@}
+ /WIDTH=@{NARROW,WIDTH,@var{n_characters}@}
/TNUMBERS=@{VALUES,LABELS,BOTH@}
(logging)
- /JOURNAL=@{ON,OFF@} ['file-name']
+ /JOURNAL=@{ON,OFF@} ['@var{file_name}']
(system files)
/COMPRESSION=@{ON,OFF@}
(miscellaneous)
/SAFER=ON
- /LOCALE='string'
+ /LOCALE='@var{string}'
(obsolete settings accepted for compatibility, but ignored)
- /BOXSTRING=@{'xxx','xxxxxxxxxxx'@}
+ /BOXSTRING=@{'@var{xxx}','@var{xxxxxxxxxxx}'@}
/CASE=@{UPPER,UPLOW@}
/CPI=cpi_value
/HIGHRES=@{ON,OFF@}
- /HISTOGRAM='c'
+ /HISTOGRAM='@var{c}'
/LOWRES=@{AUTO,ON,OFF@}
- /LPI=lpi_value
+ /LPI=@var{lpi_value}
/MENUS=@{STANDARD,EXTENDED@}
- /MXMEMORY=max_memory
+ /MXMEMORY=@var{max_memory}
/SCRIPTTAB='c'
- /TB1=@{'xxx','xxxxxxxxxxx'@}
- /TBFONTS='string'
+ /TB1=@{'@var{xxx}','@var{xxxxxxxxxxx}'@}
+ /TBFONTS='@var{string}'
/XSORT=@{YES,NO@}
@end display
@pspp{}'s execution. Since there are many subcommands to this command, its
subcommands will be examined in groups.
-For subcommands that take boolean values, ON and YES are synonymous,
-as are OFF and NO, when used as subcommand values.
+For subcommands that take boolean values, @subcmd{ON} and @subcmd{YES} are synonymous,
+as are @subcmd{OFF} and @subcmd{NO}, when used as subcommand values.
The data input subcommands affect the way that data is read from data
files. The data input subcommands are
@item DECIMAL
@anchor{SET DECIMAL}
-This value may be set to DOT or COMMA.
+This value may be set to @subcmd{DOT} or @subcmd{COMMA}.
Setting it to DOT causes the decimal point character to be
@samp{.} and the grouping character to be @samp{,}.
-Setting it to COMMA
+Setting it to @subcmd{COMMA}
causes the decimal point character to be @samp{,} and the grouping
character to be @samp{.}.
The default value is determined from the system locale.
data file or used in a date construction expression (@pxref{Date
Construction}). If a 4-digit year is specified for the epoch, then
2-digit years are interpreted starting from that year, known as the
-epoch. If AUTOMATIC (the default) is specified, then the epoch begins
+epoch. If @subcmd{AUTOMATIC} (the default) is specified, then the epoch begins
69 years before the current date.
@item RIB
@item MXLOOPS
The maximum number of iterations for an uncontrolled loop (@pxref{LOOP}).
-The default MXLOOPS is 40.
+The default @var{max_loops} is 40.
@item SEED
The initial pseudo-random number seed. Set to a real number or to
@itemize @bullet
@item
-The ERASE command.
+The @cmd{ERASE} command.
@item
-The HOST command.
+The @cmd{HOST} command.
@item
-The PERMISSIONS command.
+The @cmd{PERMISSIONS} command.
@item
Pipes (file names beginning or ending with @samp{|}).
@end itemize
The following are all examples of acceptable syntax on common GNU/Linux
systems.
@example
-
SET LOCALE='iso-8859-1'.
SET LOCALE='ru_RU.cp1251'.
SET LOCALE='japanese'.
-
@end example
Contrary to the intuition, this command does not affect any aspect
@end table
@node SHOW
-@comment node-name, next, previous, up
@section SHOW
@vindex SHOW
@cmd{SHOW} can be used to display the current state of @pspp{}'s execution
parameters. Parameters that can be changed using @cmd{SET}
(@pxref{SET}), can be examined using @cmd{SHOW} using the subcommand
-with the same name. @code{SHOW} supports the following additional
+with the same name. @cmd{SHOW} supports the following additional
subcommands:
-@table @code
-@item ALL
+@table @bullet
+@item @subcmd{ALL}
Show all settings.
-@item CC
+@item @subcmd{CC}
Show all custom currency settings (CCA through CCE).
-@item DIRECTORY
+@item @subcmd{DIRECTORY}
Shows the current working directory.
-@item ENVIRONMENT
+@item @subcmd{ENVIRONMENT}
Shows the operating system details.
-@item TEMPDIR
+@item @subcmd{TEMPDIR}
Shows the path of the directory where temporary files will be stored.
-@item VERSION
+@item @subcmd{VERSION}
Shows the version of this installation of @pspp{}.
-@item WARRANTY
+@item @subcmd{WARRANTY}
Show details of the lack of warranty for @pspp{}.
-@item COPYING / LICENSE
+@item @subcmd{COPYING} / @subcmd{LICENSE}
Display the terms of @pspp{}'s copyright licence (@pxref{License}).
@end table
-Specifying @cmd{SHOW} without any subcommands is equivalent to SHOW ALL.
+Specifying @cmd{SHOW} without any subcommands is equivalent to @subcmd{SHOW ALL}.
@node SUBTITLE
@section SUBTITLE
@vindex SUBTITLE
@display
-SUBTITLE 'subtitle_string'.
+SUBTITLE '@var{subtitle_string}'.
or
-SUBTITLE subtitle_string.
+SUBTITLE @var{subtitle_string}.
@end display
@cmd{SUBTITLE} provides a subtitle to a particular @pspp{}
@vindex TITLE
@display
-TITLE 'title_string'.
+TITLE '@var{title_string}'.
or
-TITLE title_string.
+TITLE @var{title_string}.
@end display
@cmd{TITLE} provides a title to a particular @pspp{} run.
@display
ADD VALUE LABELS
- /var_list value 'label' [value 'label']@dots{}
+ /@var{var_list} @var{value} '@var{label}' [@var{value} '@var{label}']@dots{}
@end display
@cmd{ADD VALUE LABELS} has the same syntax and purpose as @cmd{VALUE
@vindex DELETE VARIABLES
@display
-DELETE VARIABLES var_list.
+DELETE VARIABLES @var{var_list}.
@end display
@cmd{DELETE VARIABLES} deletes the specified variables from the
@vindex DISPLAY
@display
-DISPLAY [SORTED] NAMES [[/VARIABLES=]var_list].
-DISPLAY [SORTED] INDEX [[/VARIABLES=]var_list].
-DISPLAY [SORTED] LABELS [[/VARIABLES=]var_list].
-DISPLAY [SORTED] VARIABLES [[/VARIABLES=]var_list].
-DISPLAY [SORTED] DICTIONARY [[/VARIABLES=]var_list].
-DISPLAY [SORTED] SCRATCH [[/VARIABLES=]var_list].
-DISPLAY [SORTED] ATTRIBUTES [[/VARIABLES=]var_list].
-DISPLAY [SORTED] @@ATTRIBUTES [[/VARIABLES=]var_list].
+DISPLAY [SORTED] NAMES [[/VARIABLES=]@var{var_list}].
+DISPLAY [SORTED] INDEX [[/VARIABLES=]@var{var_list}].
+DISPLAY [SORTED] LABELS [[/VARIABLES=]@var{var_list}].
+DISPLAY [SORTED] VARIABLES [[/VARIABLES=]@var{var_list}].
+DISPLAY [SORTED] DICTIONARY [[/VARIABLES=]@var{var_list}].
+DISPLAY [SORTED] SCRATCH [[/VARIABLES=]@var{var_list}].
+DISPLAY [SORTED] ATTRIBUTES [[/VARIABLES=]@var{var_list}].
+DISPLAY [SORTED] @@ATTRIBUTES [[/VARIABLES=]@var{var_list}].
DISPLAY [SORTED] VECTORS.
@end display
The following keywords primarily cause information about variables to
be displayed. With these keywords, by default information is
displayed about all variable in the active dataset, in the order that
-variables occur in the active dataset dictionary. The SORTED keyword
+variables occur in the active dataset dictionary. The @subcmd{SORTED} keyword
causes output to be sorted alphabetically by variable name. The
@subcmd{VARIABLES} subcommand limits output to the specified variables.
@end table
With the @code{VECTOR} keyword, @cmd{DISPLAY} lists all the currently
-declared vectors. If the SORTED keyword is given, the vectors are
+declared vectors. If the @subcmd{SORTED} keyword is given, the vectors are
listed in alphabetical order; otherwise, they are listed in textual
order of definition within the @pspp{} syntax file.
@vindex FORMATS
@display
-FORMATS var_list (fmt_spec) [var_list (fmt_spec)]@dots{}.
+FORMATS @var{var_list} (@var{fmt_spec}) [@var{var_list} (@var{fmt_spec})]@dots{}.
@end display
@cmd{FORMATS} set both print and write formats for the specified
@vindex LEAVE
@display
-LEAVE var_list.
+LEAVE @var{var_list}.
@end display
@cmd{LEAVE} prevents the specified variables from being
After that, it retains its value between cases.
This becomes useful for counters. For instance, in the example below
-the variable SUM maintains a running total of the values in the ITEM
+the variable @code{SUM} maintains a running total of the values in the @code{ITEM}
variable.
@example
@vindex MISSING VALUES
@display
-MISSING VALUES var_list (missing_values).
-
-missing_values takes one of the following forms:
- num1
- num1, num2
- num1, num2, num3
- num1 THRU num2
- num1 THRU num2, num3
- string1
- string1, string2
- string1, string2, string3
-As part of a range, LO or LOWEST may take the place of num1;
-HI or HIGHEST may take the place of num2.
+MISSING VALUES @var{var_list} (@var{missing_values}).
+
+where @var{missing_values} takes one of the following forms:
+ @var{num1}
+ @var{num1}, @var{num2}
+ @var{num1}, @var{num2}, @var{num3}
+ @var{num1} THRU @var{num2}
+ @var{num1} THRU @var{num2}, @var{num3}
+ @var{string1}
+ @var{string1}, @var{string2}
+ @var{string1}, @var{string2}, @var{string3}
+As part of a range, LO or LOWEST may take the place of @var{num1};
+HI or HIGHEST may take the place of @var{num2}.
@end display
@cmd{MISSING VALUES} sets user-missing values for numeric and string
@display
MODIFY VARS
- /REORDER=@{FORWARD,BACKWARD@} @{POSITIONAL,ALPHA@} (var_list)@dots{}
- /RENAME=(old_names=new_names)@dots{}
- /@{DROP,KEEP@}=var_list
+ /REORDER=@{FORWARD,BACKWARD@} @{POSITIONAL,ALPHA@} (@var{var_list})@dots{}
+ /RENAME=(@var{old_names}=@var{new_names})@dots{}
+ /@{DROP,KEEP@}=@var{var_list}
/MAP
@end display
active dataset.
At least one subcommand must be specified, and no subcommand may be
-specified more than once. DROP and KEEP may not both be specified.
+specified more than once. @subcmd{DROP} and @subcmd{KEEP} may not both
+be specified.
The @subcmd{REORDER} subcommand changes the order of variables in the active
dataset. Specify one or more lists of variable names in parentheses. By
default, each list of variables is rearranged into the specified order.
To put the variables into the reverse of the specified order, put
-keyword BACKWARD before the parentheses. To put them into alphabetical
-order in the dictionary, specify keyword ALPHA before the parentheses.
-BACKWARD and ALPHA may also be combined.
+keyword @subcmd{BACKWARD} before the parentheses. To put them into alphabetical
+order in the dictionary, specify keyword @subcmd{ALPHA} before the parentheses.
+@subcmd{BACKWARD} and @subcmd{ALPHA} may also be combined.
-To rename variables in the active dataset, specify RENAME, an equals sign
+To rename variables in the active dataset, specify @subcmd{RENAME}, an equals sign
(@samp{=}), and lists of the old variable names and new variable names
separated by another equals sign within parentheses. There must be the
same number of old and new variable names. Each old variable is renamed to
The @subcmd{KEEP} subcommand keeps the specified list of variables in the active
dataset. Any unlisted variables are deleted from the active dataset.
-MAP is currently ignored.
+@subcmd{MAP} is currently ignored.
-If either DROP or KEEP is specified, the data is read; otherwise it is
-not.
+If either @subcmd{DROP} or @subcmd{KEEP} is specified, the data is read;
+otherwise it is not.
@cmd{MODIFY VARS} may not be specified following @cmd{TEMPORARY}
(@pxref{TEMPORARY}).
@display
MRSETS
- /MDGROUP NAME=name VARIABLES=var_list VALUE=value
+ /MDGROUP NAME=@var{name} VARIABLES=@var{var_list} VALUE=@var{value}
[CATEGORYLABELS=@{VARLABELS,COUNTEDVALUES@}]
- [@{LABEL='label',LABELSOURCE=VARLABEL@}]
+ [@{LABEL='@var{label}',LABELSOURCE=VARLABEL@}]
- /MCGROUP NAME=name VARIABLES=var_list [LABEL='label']
+ /MCGROUP NAME=@var{name} VARIABLES=@var{var_list} [LABEL='@var{label}']
- /DELETE NAME=@{[names],ALL@}
+ /DELETE NAME=@{[@var{names}],ALL@}
- /DISPLAY NAME=@{[names],ALL@}
+ /DISPLAY NAME=@{[@var{names}],ALL@}
@end display
@cmd{MRSETS} creates, modifies, deletes, and displays multiple
Any number of subcommands may be specified in any order.
The @subcmd{MDGROUP} subcommand creates a new multiple dichotomy set or
-replaces an existing multiple response set. The NAME, VARIABLES, and
-VALUE specifications are required. The others are optional:
+replaces an existing multiple response set. The @subcmd{NAME},
+@subcmd{VARIABLES}, and
+@subcmd{VALUE} specifications are required. The others are optional:
@itemize @bullet
@item
-NAME specifies the name used in syntax for the new multiple dichotomy
+@var{NAME} specifies the name used in syntax for the new multiple dichotomy
set. The name must begin with @samp{$}; it must otherwise follow the
rules for identifiers (@pxref{Tokens}).
@item
-VARIABLES specifies the variables that belong to the set. At least
+@subcmd{VARIABLES} specifies the variables that belong to the set. At least
two variables must be specified. The variables must be all string or
all numeric.
@item
-VALUE specifies the counted value. If the variables are numeric, the
+@subcmd{VALUE} specifies the counted value. If the variables are numeric, the
value must be an integer. If the variables are strings, then the
value must be a string that is no longer than the shortest of the
variables in the set (ignoring trailing spaces).
@item
-CATEGORYLABELS optionally specifies the source of the labels for each
+@subcmd{CATEGORYLABELS} optionally specifies the source of the labels for each
category in the set:
@itemize @minus
@item
-VARLABELS, the default, uses variable labels or, for variables without
+@subcmd{VARLABELS}, the default, uses variable labels or, for variables without
variable labels, variable names. @pspp{} warns if two variables have the
same variable label, since these categories cannot be distinguished in
output.
@item
-COUNTEDVALUES instead uses each variable's value label for the counted
+@subcmd{COUNTEDVALUES} instead uses each variable's value label for the counted
value. @pspp{} warns if two variables have the same value label for the
counted value or if one of the variables lacks a value label, since
such categories cannot be distinguished in output.
@end itemize
@item
-LABEL optionally specifies a label for the multiple response set. If
-neither LABEL nor LABELSOURCE=VARLABEL is specified, the set is
+@subcmd{LABEL} optionally specifies a label for the multiple response set. If
+neither @subcmd{LABEL} nor @subcmd{LABELSOURCE=VARLABEL} is specified, the set is
unlabeled.
@item
-LABELSOURCE=VARLABEL draws the multiple response set's label from the
+@subcmd{LABELSOURCE=VARLABEL} draws the multiple response set's label from the
first variable label among the variables in the set; if none of the
variables has a label, the name of the first variable is used.
-LABELSOURCE=VARLABEL must be used with CATEGORYLABELS=COUNTEDVALUES.
-It is mutually exclusive with LABEL.
+@subcmd{LABELSOURCE=VARLABEL} must be used with @subcmd{CATEGORYLABELS=COUNTEDVALUES}.
+It is mutually exclusive with @subcmd{LABEL}.
@end itemize
The @subcmd{MCGROUP} subcommand creates a new multiple category set or
-replaces an existing multiple response set. The NAME and VARIABLES
-specifications are required, and LABEL is optional. Their meanings
-are as described above to MDGROUP. @pspp{} warns if two variables in the
+replaces an existing multiple response set. The @subcmd{NAME} and @subcmd{VARIABLES}
+specifications are required, and @subcmd{LABEL} is optional. Their meanings
+are as described above in @subcmd{MDGROUP}. @pspp{} warns if two variables in the
set have different value labels for a single value, since each of the
variables in the set should have the same possible categories.
@vindex NUMERIC
@display
-NUMERIC /var_list [(fmt_spec)].
+NUMERIC /@var{var_list} [(@var{fmt_spec})].
@end display
@cmd{NUMERIC} explicitly declares new numeric variables, optionally
@vindex PRINT FORMATS
@display
-PRINT FORMATS var_list (fmt_spec) [var_list (fmt_spec)]@dots{}.
+PRINT FORMATS @var{var_list} (@var{fmt_spec}) [@var{var_list} (@var{fmt_spec})]@dots{}.
@end display
@cmd{PRINT FORMATS} sets the print formats for the specified
@vindex RENAME VARIABLES
@display
-RENAME VARIABLES (old_names=new_names)@dots{} .
+RENAME VARIABLES (@var{old_names}=@var{new_names})@dots{} .
@end display
@cmd{RENAME VARIABLES} changes the names of variables in the active
@display
VALUE LABELS
- /var_list value 'label' [value 'label']@dots{}
+ /@var{var_list} @var{value} '@var{label}' [@var{value} '@var{label}']@dots{}
@end display
@cmd{VALUE LABELS} allows values of numeric and short string
@vindex STRING
@display
-STRING /var_list (fmt_spec).
+STRING /@var{var_list} (@var{fmt_spec}).
@end display
@cmd{STRING} creates new string variables for use in
@display
VARIABLE ATTRIBUTE
- VARIABLES=var_list
- ATTRIBUTE=name('value') [name('value')]@dots{}
- ATTRIBUTE=name@b{[}index@b{]}('value') [name@b{[}index@b{]}('value')]@dots{}
- DELETE=name [name]@dots{}
- DELETE=name@b{[}index@b{]} [name@b{[}index@b{]}]@dots{}
+ VARIABLES=@var{var_list}
+ ATTRIBUTE=@var{name}('@var{value}') [@var{name}('@var{value}')]@dots{}
+ ATTRIBUTE=@var{name}@b{[}@var{index}@b{]}('@var{value}') [@var{name}@b{[}@var{index}@b{]}('@var{value}')]@dots{}
+ DELETE=@var{name} [@var{name}]@dots{}
+ DELETE=@var{name}@b{[}@var{index}@b{]} [@var{name}@b{[}@var{index}@b{]}]@dots{}
@end display
@cmd{VARIABLE ATTRIBUTE} adds, modifies, or removes user-defined
them.
The required @subcmd{VARIABLES} subcommand must come first. Specify the
-variables to which the following ATTRIBUTE or @subcmd{DELETE} subcommand
+variables to which the following @subcmd{ATTRIBUTE} or @subcmd{DELETE} subcommand
should apply.
Use the @subcmd{ATTRIBUTE} subcommand to add or modify custom variable
attributes. Specify the name of the attribute as an identifier
(@pxref{Tokens}), followed by the desired value, in parentheses, as a
quoted string. The specified attributes are then added or modified in
-the variables specified on VARIABLES. Attribute names that begin with
+the variables specified on @subcmd{VARIABLES}. Attribute names that begin with
@code{$} are reserved for @pspp{}'s internal use, and attribute names
that begin with @code{@@} or @code{$@@} are not displayed by most @pspp{}
commands that display other attributes. Other attribute names are not
element (number 1) is not distinguished from a non-array attribute.
Use the @subcmd{DELETE} subcommand to delete an attribute from the variable
-specified on VARIABLES. Specify an attribute name by itself to delete
+specified on @subcmd{VARIABLES}. Specify an attribute name by itself to delete
an entire attribute, including all array elements for attribute
arrays. Specify an attribute name followed by an array index in
square brackets to delete a single element of an attribute array. In
@display
VARIABLE LABELS
- var_list 'var_label'
- [ /var_list 'var_label']
+ @var{var_list} '@var{var_label}'
+ [ /@var{var_list} '@var{var_label}']
.
.
.
- [ /var_list 'var_label']
+ [ /@var{var_list} '@var{var_label}']
@end display
@cmd{VARIABLE LABELS} associates explanatory names
@node VARIABLE ALIGNMENT
-@comment node-name, next, previous, u
@section VARIABLE ALIGNMENT
@vindex VARIABLE ALIGNMENT
@display
VARIABLE ALIGNMENT
- var_list ( LEFT | RIGHT | CENTER )
- [ /var_list ( LEFT | RIGHT | CENTER ) ]
+ @var{var_list} ( LEFT | RIGHT | CENTER )
+ [ /@var{var_list} ( LEFT | RIGHT | CENTER ) ]
.
.
.
- [ /var_list ( LEFT | RIGHT | CENTER ) ]
+ [ /@var{var_list} ( LEFT | RIGHT | CENTER ) ]
@end display
@cmd{VARIABLE ALIGNMENT} sets the alignment of variables for display editing
@node VARIABLE WIDTH
-@comment node-name, next, previous, up
@section VARIABLE WIDTH
@vindex VARIABLE WIDTH
@display
VARIABLE WIDTH
- var_list (width)
- [ /var_list (width) ]
+ @var{var_list} (width)
+ [ /@var{var_list} (width) ]
.
.
.
- [ /var_list (width) ]
+ [ /@var{var_list} (width) ]
@end display
@cmd{VARIABLE WIDTH} sets the column width of variables for display editing
@node VARIABLE LEVEL
-@comment node-name, next, previous, up
@section VARIABLE LEVEL
@vindex VARIABLE LEVEL
@display
VARIABLE LEVEL
- var_list ( SCALE | NOMINAL | ORDINAL )
- [ /var_list ( SCALE | NOMINAL | ORDINAL ) ]
+ @var{var_list} ( SCALE | NOMINAL | ORDINAL )
+ [ /@var{var_list} ( SCALE | NOMINAL | ORDINAL ) ]
.
.
.
- [ /var_list ( SCALE | NOMINAL | ORDINAL ) ]
+ [ /@var{var_list} ( SCALE | NOMINAL | ORDINAL ) ]
@end display
@cmd{VARIABLE LEVEL} sets the measurement level of variables.
@display
Two possible syntaxes:
- VECTOR vec_name=var_list.
- VECTOR vec_name_list(count [format]).
+ VECTOR @var{vec_name}=@var{var_list}.
+ VECTOR @var{vec_name_list}(@var{count} [@var{format}]).
@end display
@cmd{VECTOR} allows a group of variables to be accessed as if they
@vindex WRITE FORMATS
@display
-WRITE FORMATS var_list (fmt_spec) [var_list (fmt_spec)]@dots{}.
+WRITE FORMATS @var{var_list} (@var{fmt_spec}) [@var{var_list} (@var{fmt_spec})]@dots{}.
@end display
@cmd{WRITE FORMATS} sets the write formats for the specified variables
projects / pspp / commitdiff