-@node System and Portable Files, Variable Attributes, Data Input and Output, Top
+@node System and Portable Files
@chapter System Files and Portable Files
The commands in this chapter read, write, and examine system files and
* APPLY DICTIONARY:: Apply system file dictionary to active file.
* EXPORT:: Write to a portable file.
* GET:: Read from a system file.
+* GET DATA:: Read from foreign files.
* IMPORT:: Read from a portable file.
* MATCH FILES:: Merge system files.
* SAVE:: Write to a system file.
* SYSFILE INFO:: Display system file dictionary.
-* XSAVE:: Write to a system file, as a transform.
+* XEXPORT:: Write to a portable file, as a transformation.
+* XSAVE:: Write to a system file, as a transformation.
@end menu
-@node APPLY DICTIONARY, EXPORT, System and Portable Files, System and Portable Files
+@node APPLY DICTIONARY
@section APPLY DICTIONARY
@vindex APPLY DICTIONARY
@display
-APPLY DICTIONARY FROM='filename'.
+APPLY DICTIONARY FROM=@{'file-name',file_handle@}.
@end display
@cmd{APPLY DICTIONARY} applies the variable labels, value labels,
-and missing values from variables in a system file to corresponding
+and missing values taken from a file to corresponding
variables in the active file. In some cases it also updates the
weighting variable.
-Specify a system file with a file name string or as a file handle
-(@pxref{FILE HANDLE}). The dictionary in the system file will be read,
-but it will not replace the active file dictionary. The system file's
-data will not be read.
+Specify a system file, portable file, or scratch file with a file name
+string or as a file handle (@pxref{File Handles}). The dictionary in the
+file will be read, but it will not replace the active file dictionary.
+The file's data will not be read.
Only variables with names that exist in both the active file and the
system file are considered. Variables with the same name but different
active
file. The system file is not modified.
-@node EXPORT, GET, APPLY DICTIONARY, System and Portable Files
+@node EXPORT
@section EXPORT
@vindex EXPORT
@display
EXPORT
- /OUTFILE='filename'
+ /OUTFILE='file-name'
+ /UNSELECTED=@{RETAIN,DELETE@}
+ /DIGITS=n
/DROP=var_list
/KEEP=var_list
/RENAME=(src_names=target_names)@dots{}
+ /TYPE=@{COMM,TAPE@}
+ /MAP
@end display
The @cmd{EXPORT} procedure writes the active file dictionary and data to a
-specified portable file.
+specified portable file or scratch file.
+
+By default, cases excluded with FILTER are written to the
+file. These can be excluded by specifying DELETE on the UNSELECTED
+subcommand. Specifying RETAIN makes the default explicit.
+
+Portable files express real numbers in base 30. Integers are always
+expressed to the maximum precision needed to make them exact.
+Non-integers are, by default, expressed to the machine's maximum
+natural precision (approximately 15 decimal digits on many machines).
+If many numbers require this many digits, the portable file may
+significantly increase in size. As an alternative, the DIGITS
+subcommand may be used to specify the number of decimal digits of
+precision to write. DIGITS applies only to non-integers.
The OUTFILE subcommand, which is the only required subcommand, specifies
-the portable file to be written as a file name string or a file handle
-(@pxref{FILE HANDLE}).
+the portable file or scratch file to be written as a file name string or
+a file handle (@pxref{File Handles}).
DROP, KEEP, and RENAME follow the same format as the SAVE procedure
(@pxref{SAVE}).
+The TYPE subcommand specifies the character set for use in the
+portable file. Its value is currently not used.
+
+The MAP subcommand is currently ignored.
+
@cmd{EXPORT} is a procedure. It causes the active file to be read.
-@node GET, IMPORT, EXPORT, System and Portable Files
+@node GET
@section GET
@vindex GET
@display
GET
- /FILE='filename'
+ /FILE=@{'file-name',file_handle@}
/DROP=var_list
/KEEP=var_list
/RENAME=(src_names=target_names)@dots{}
@end display
@cmd{GET} clears the current dictionary and active file and
-replaces them with the dictionary and data from a specified system file.
+replaces them with the dictionary and data from a specified file.
The FILE subcommand is the only required subcommand. Specify the system
-file to be read as a string file name or a file handle (@pxref{FILE
-HANDLE}).
+file, portable file, or scratch file to be read as a string file name or
+a file handle (@pxref{File Handles}).
-By default, all the variables in a system file are read. The DROP
+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 KEEP subcommand can be used to specify variable
that are to be read, with all other variables not read.
-Normally variables in a system file retain the names that they were
+Normally variables in a file retain the names that they were
saved under. Use the 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
once. For instance, @samp{/RENAME=A=B}. This alternate syntax is
deprecated.
-DROP, KEEP, and RENAME are performed in left-to-right order. They
-each may be present any number of times. @cmd{GET} never modifies a
-system file on disk. Only the active file read from the system file
+DROP, KEEP, and RENAME are executed in left-to-right order.
+Each may be present any number of times. @cmd{GET} never modifies a
+file on disk. Only the active file read from the file
is affected by these subcommands.
@cmd{GET} does not cause the data to be read, only the dictionary. The data
is read later, when a procedure is executed.
-@node IMPORT, MATCH FILES, GET, System and Portable Files
+Use of @cmd{GET} to read a portable file or scratch file is a PSPP
+extension.
+
+@node GET DATA
+@section GET DATA
+@vindex GET DATA
+
+@display
+GET DATA /TYPE=gnm
+ /FILE=@{'file-name'@}
+
+ /SHEET=@{NAME 'sheet-name', INDEX n@}
+ /CELLRANGE=@{RANGE 'range', FULL@}
+ /READNAMES=@{ON, OFF@}
+ /ASSUMEDVARWIDTH=n.
+@end display
+
+The @cmd{GET DATA} command is used to read files and other data sources
+created by other applications.
+When this command is executed, the current dictionary and active file are
+replaced with variables and data read from the specified source.
+The TYPE subcommand is mandatory and determines the type of the file or source to read.
+Currently @samp{gnm} is the only supported type.
+
+@cindex Gnumeric
+@cindex spreadsheet files
+The @samp{gnm} type is used to read spreadsheet files created by
+Gnumeric (@url{http://gnumeric.org}).
+With this type, the FILE subcommand must be used, to specify the
+spreadsheet file to read.
+All other subcommands are optional.
+The format of each variable is determined by the format of the spreadsheet
+cell containing the first datum for the variable.
+If this cell is of string (text) format, then the width of the variable is
+determined from the length of the string it contains, unless the
+ASSUMEDVARWIDTH subcommand is given.
+
+The SHEET subcommand specifies the sheet within the spreadsheet file to read.
+There are two forms of the SHEET subcommand.
+In the first form,
+@samp{/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
+integer which is the index of the sheet to read.
+The first sheet has the index 1.
+If the SHEET subcommand is omitted, then the command will read the
+first sheet in the file.
+
+The CELLRANGE subcommand specifies the range of cells within the sheet to read.
+If the subcommand is given as @samp{/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
+columns C--P, and rows 3--19 inclusive.
+If no CELLRANGE subcommand is given, then the entire sheet is read.
+
+If @samp{/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.
+If the READNAMES command is omitted, or if @samp{/READNAMES=OFF} is
+used, then the variables receive automatically assigned names.
+
+The ASSUMEDVARWIDTH subcommand specifies the maximum width of string
+variables read from the file.
+If omitted, the default value is determined from the length of the
+string in the first spreadsheet cell for each variable.
+
+
+@node IMPORT
@section IMPORT
@vindex IMPORT
@display
IMPORT
- /FILE='filename'
+ /FILE='file-name'
/TYPE=@{COMM,TAPE@}
/DROP=var_list
/KEEP=var_list
The @cmd{IMPORT} transformation clears the active file dictionary and
data and
-replaces them with a dictionary and data from a portable file on disk.
+replaces them with a dictionary and data from a system, portable file,
+or scratch file.
The FILE subcommand, which is the only required subcommand, specifies
the portable file to be read as a file name string or a file handle
-(@pxref{FILE HANDLE}).
+(@pxref{File Handles}).
The TYPE subcommand is currently not used.
@cmd{IMPORT} does not cause the data to be read, only the dictionary. The
data is read later, when a procedure is executed.
-@node MATCH FILES, SAVE, IMPORT, System and Portable Files
+Use of @cmd{IMPORT} to read a system file or scratch file is a PSPP
+extension.
+
+@node MATCH FILES
@section MATCH FILES
@vindex MATCH FILES
@display
MATCH FILES
- /BY var_list
- /@{FILE,TABLE@}=@{*,'filename'@}
- /DROP=var_list
- /KEEP=var_list
+ /@{FILE,TABLE@}=@{*,'file-name'@}
/RENAME=(src_names=target_names)@dots{}
/IN=var_name
+
+ /BY=var_list
+ /DROP=var_list
+ /KEEP=var_list
/FIRST=var_name
/LAST=var_name
/MAP
@end display
-@cmd{MATCH FILES} merges one or more system files, optionally
-including the active file. Records with the same values for BY
-variables are combined into a single record. Records with different
-values are output in order. Thus, multiple sorted system files are
-combined into a single sorted system file based on the value of the BY
+@cmd{MATCH FILES} merges one or more system, portable, or scratch files,
+optionally
+including the active file. Cases with the same values for BY
+variables are combined into a single case. Cases with different
+values are output in order. Thus, multiple sorted files are
+combined into a single sorted file based on the value of the BY
variables. The results of the merge become the new active file.
-The BY subcommand specifies a list of variables that are used to match
-records from each of the system files. Variables specified must exist
-in all the files specified on FILE and TABLE. BY should usually be
-specified. If TABLE is used then BY is required.
-
-Specify FILE with a system file as a file name string or file handle
-(@pxref{FILE HANDLE}), or with an asterisk (@samp{*}) to
+Specify FILE with a system, portable, or scratch file as a file name
+string or file handle
+(@pxref{File Handles}), or with an asterisk (@samp{*}) to
indicate the current active file. The files specified on FILE are
merged together based on the BY variables, or combined case-by-case if
-BY is not specified. Normally at least two FILE subcommands should be
-specified.
+BY is not specified.
-Specify TABLE with a system file to use it as a @dfn{table
-lookup file}. Records in table lookup files are not used up after
+Specify TABLE with a file to use it as a @dfn{table
+lookup file}. Cases in table lookup files are not used up after
they've been used once. This means that data in table lookup files can
-correspond to any number of records in FILE files. Table lookup files
+correspond to any number of cases in FILE files. Table lookup files
correspond to lookup tables in traditional relational database systems.
-It is incorrect to have records with duplicate BY values in table lookup
-files.
-
-Any number of FILE and TABLE subcommands may be specified. Each
-instance of FILE or TABLE can be followed by DROP, KEEP, and/or RENAME
-subcommands. These take the same form as the corresponding subcommands
-of @cmd{GET} (@pxref{GET}), and perform the same functions.
+If a table lookup file contains more than one case with a given set of
+BY variables, only the first case is used.
+
+Any number of FILE and TABLE subcommands may be specified.
+Ordinarily, at least two FILE subcommands, or one FILE and at least
+one TABLE, should be specified. Each instance of FILE or TABLE can be
+followed by any sequence of RENAME subcommands. These have the same
+form and meaning as the corresponding subcommands of @cmd{GET}
+(@pxref{GET}), but apply only to variables in the given file.
+
+Each FILE or TABLE may optionally be followed by an IN subcommand,
+which creates a numeric variable with the specified name and format
+F1.0. The IN variable takes value 1 in a case if the given file
+contributed a row to the merged file, 0 otherwise. The DROP, KEEP,
+and RENAME subcommands do not affect IN variables.
+
+When more than one FILE or TABLE contains a variable with a given
+name, those variables must all have the same type (numeric or string)
+and, for string variables, the same width. This rules applies to
+variable names after renaming with RENAME; thus, RENAME can be used to
+resolve conflicts.
+
+FILE and TABLE must be specified at the beginning of the command, with
+any RENAME or IN specifications immediately after the corresponding
+FILE or TABLE. These subcommands are followed by BY, DROP, KEEP,
+FIRST, LAST, and MAP.
-Variables belonging to files that are not present for the current case
-are set to the system-missing value for numeric variables or spaces for
-string variables.
-
-IN, FIRST, LAST, and MAP are currently not used.
+The BY subcommand specifies a list of variables that are used to match
+cases from each of the files. When TABLE or IN is used, BY is
+required; otherwise, it is optional. When BY is specified, all the
+files named on FILE and TABLE subcommands must be sorted in ascending
+order of the BY variables. Variables belonging to files that are not
+present for the current case are set to the system-missing value for
+numeric variables or spaces for string variables.
+
+The DROP and KEEP subcommands allow variables to be dropped from or
+reordered within the new active file. These subcommands have the same
+form and meaning as the corresponding subcommands of @cmd{GET}
+(@pxref{GET}). They apply to the new active file as a whole, not to
+individual input files. The variable names specified on DROP and KEEP
+are those after any renaming with RENAME.
+
+The optional FIRST and LAST subcommands name variables that @cmd{MATCH
+FILES} adds to the active file. The new variables are numeric with
+print and write format F1.0. The value of the FIRST variable is 1 in
+the first case with a given set of values for the BY variables, and 0
+in other cases. Similarly, the LAST variable is 1 in the last case
+with a given of BY values, and 0 in other cases.
@cmd{MATCH FILES} may not be specified following @cmd{TEMPORARY}
(@pxref{TEMPORARY}) if the active file is used as an input source.
-@node SAVE, SYSFILE INFO, MATCH FILES, System and Portable Files
+Use of portable or scratch files on @cmd{MATCH FILES} is a PSPP
+extension.
+
+@node SAVE
@section SAVE
@vindex SAVE
@display
SAVE
- /OUTFILE='filename'
+ /OUTFILE=@{'file-name',file_handle@}
+ /UNSELECTED=@{RETAIN,DELETE@}
/@{COMPRESSED,UNCOMPRESSED@}
+ /PERMISSIONS=@{WRITEABLE,READONLY@}
/DROP=var_list
/KEEP=var_list
+ /VERSION=version
/RENAME=(src_names=target_names)@dots{}
+ /NAMES
+ /MAP
@end display
The @cmd{SAVE} procedure causes the dictionary and data in the active
file to
-be written to a system file.
+be written to a system file or scratch file.
+
+OUTFILE is the only required subcommand. Specify the system file or
+scratch file to be written as a string file name or a file handle
+(@pxref{File Handles}).
-FILE is the only required subcommand. Specify the system
-file to be written as a string file name or a file handle (@pxref{FILE
-HANDLE}).
+By default, cases excluded with FILTER are written to the system file.
+These can be excluded by specifying DELETE on the UNSELECTED
+subcommand. Specifying RETAIN makes the default explicit.
The COMPRESS and 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 PERMISSIONS subcommand specifies permissions for the new system
+file. WRITEABLE, the default, creates the file with read and write
+permission. READONLY creates the file for read-only access.
+
By default, all the variables in the active file dictionary are written
to the system file. The DROP subcommand can be used to specify a list
of variables not to be written. In contrast, KEEP specifies variables
the active file. DROP, KEEP, and RENAME only affect the system file
written to disk.
+The VERSION subcommand specifies the version of the file format. Valid
+versions are 2 and 3. The default version is 3. In version 2 system
+files, variable names longer than 8 bytes will be truncated. The two
+versions are otherwise identical.
+
+The NAMES and MAP subcommands are currently ignored.
+
@cmd{SAVE} causes the data to be read. It is a procedure.
-@node SYSFILE INFO, XSAVE, SAVE, System and Portable Files
+@node SYSFILE INFO
@section SYSFILE INFO
@vindex SYSFILE INFO
@display
-SYSFILE INFO FILE='filename'.
+SYSFILE INFO FILE='file-name'.
@end display
@cmd{SYSFILE INFO} reads the dictionary in a system file and
@cmd{SYSFILE INFO} does not affect the current active file.
-@node XSAVE, , SYSFILE INFO, System and Portable Files
+@node XEXPORT
+@section XEXPORT
+@vindex XEXPORT
+
+@display
+XEXPORT
+ /OUTFILE='file-name'
+ /DIGITS=n
+ /DROP=var_list
+ /KEEP=var_list
+ /RENAME=(src_names=target_names)@dots{}
+ /TYPE=@{COMM,TAPE@}
+ /MAP
+@end display
+
+The @cmd{EXPORT} transformation writes the active file dictionary and
+data to a specified portable file.
+
+This transformation is a PSPP extension.
+
+It is similar to the @cmd{EXPORT} procedure, with two differences:
+
+@itemize
+@item
+@cmd{XEXPORT} is a transformation, not a procedure. It is executed when
+the data is read by a procedure or procedure-like command.
+
+@item
+@cmd{XEXPORT} does not support the UNSELECTED subcommand.
+@end itemize
+
+@xref{EXPORT}, for more information.
+
+@node XSAVE
@section XSAVE
@vindex XSAVE
@display
XSAVE
- /FILE='filename'
+ /OUTFILE='file-name'
/@{COMPRESSED,UNCOMPRESSED@}
+ /PERMISSIONS=@{WRITEABLE,READONLY@}
/DROP=var_list
/KEEP=var_list
+ /VERSION=version
/RENAME=(src_names=target_names)@dots{}
+ /NAMES
+ /MAP
@end display
The @cmd{XSAVE} transformation writes the active file dictionary and
-data to a
-system file stored on disk.
+data to a system file or scratch file. It is similar to the @cmd{SAVE}
+procedure, with two differences:
+
+@itemize
+@item
+@cmd{XSAVE} is a transformation, not a procedure. It is executed when
+the data is read by a procedure or procedure-like command.
+
+@item
+@cmd{XSAVE} does not support the UNSELECTED subcommand.
+@end itemize
-@cmd{XSAVE} is a transformation, not a procedure. It is executed when the
-data is read by a procedure or procedure-like command. In all other
-respects, @cmd{XSAVE} is identical to @cmd{SAVE}. @xref{SAVE}, for
-more information on syntax and usage.
+@xref{SAVE}, for more information.
@setfilename ignored
projects / pspp-builds.git / blobdiff