doc/files.texi

   1 @node System and Portable Files, Variable Attributes, Data Input and Output, Top
   2 @chapter System Files and Portable Files
   3
   4 The commands in this chapter read, write, and examine system files and
   5 portable files.
   6
   7 @menu
   8 * APPLY DICTIONARY::            Apply system file dictionary to active file.
   9 * EXPORT::                      Write to a portable file.
  10 * GET::                         Read from a system file.
  11 * IMPORT::                      Read from a portable file.
  12 * MATCH FILES::                 Merge system files.
  13 * SAVE::                        Write to a system file.
  14 * SYSFILE INFO::                Display system file dictionary.
  15 * XEXPORT::                     Write to a portable file, as a transformation.
  16 * XSAVE::                       Write to a system file, as a transformation.
  17 @end menu
  18
  19 @node APPLY DICTIONARY
  20 @section APPLY DICTIONARY
  21 @vindex APPLY DICTIONARY
  22
  23 @display
  24 APPLY DICTIONARY FROM='filename'.
  25 @end display
  26
  27 @cmd{APPLY DICTIONARY} applies the variable labels, value labels,
  28 and missing values from variables in a system file to corresponding
  29 variables in the active file.  In some cases it also updates the
  30 weighting variable.
  31
  32 Specify a system file with a file name string or as a file handle
  33 (@pxref{FILE HANDLE}).  The dictionary in the system file will be read,
  34 but it will not replace the active file dictionary.  The system file's
  35 data will not be read.
  36
  37 Only variables with names that exist in both the active file and the
  38 system file are considered.  Variables with the same name but different
  39 types (numeric, string) will cause an error message.  Otherwise, the
  40 system file variables' attributes will replace those in their matching
  41 active file variables, as described below.
  42
  43 If a system file variable has a variable label, then it will replace the
  44 active file variable's variable label.  If the system file variable does
  45 not have a variable label, then the active file variable's variable
  46 label, if any, will be retained.
  47
  48 If the active file variable is numeric or short string, then value
  49 labels and missing values, if any, will be copied to the active file
  50 variable.  If the system file variable does not have value labels or
  51 missing values, then those in the active file variable, if any, will not
  52 be disturbed.
  53
  54 Finally, weighting of the active file is updated (@pxref{WEIGHT}).  If
  55 the active file has a weighting variable, and the system file does not,
  56 or if the weighting variable in the system file does not exist in the
  57 active file, then the active file weighting variable, if any, is
  58 retained.  Otherwise, the weighting variable in the system file becomes
  59 the active file weighting variable.
  60
  61 @cmd{APPLY DICTIONARY} takes effect immediately.  It does not read the
  62 active
  63 file.  The system file is not modified.
  64
  65 @node EXPORT
  66 @section EXPORT
  67 @vindex EXPORT
  68
  69 @display
  70 EXPORT
  71         /OUTFILE='filename'
  72         /UNSELECTED=@{RETAIN,DELETE@}
  73         /DIGITS=n
  74         /DROP=var_list
  75         /KEEP=var_list
  76         /RENAME=(src_names=target_names)@dots{}
  77         /TYPE=@{COMM,TAPE@}
  78         /MAP
  79 @end display
  80
  81 The @cmd{EXPORT} procedure writes the active file dictionary and data to a
  82 specified portable file.
  83
  84 By default, cases excluded with FILTER are written to the portable
  85 file.  These can be excluded by specifying DELETE on the UNSELECTED
  86 subcommand.  Specifying RETAIN makes the default explicit.
  87
  88 Portable files express real numbers in base 30.  Integers are always
  89 expressed to the maximum precision needed to make them exact.
  90 Non-integers are, by default, expressed to the machine's maximum
  91 natural precision (approximately 15 decimal digits on many machines).
  92 If many numbers require this many digits, the portable file may
  93 significantly increase in size.  As an alternative, the DIGITS
  94 subcommand may be used to specify the number of decimal digits of
  95 precision to write.  DIGITS applies only to non-integers.
  96
  97 The OUTFILE subcommand, which is the only required subcommand, specifies
  98 the portable file to be written as a file name string or a file handle
  99 (@pxref{FILE HANDLE}).
 100
 101 DROP, KEEP, and RENAME follow the same format as the SAVE procedure
 102 (@pxref{SAVE}).
 103
 104 The TYPE subcommand specifies the character set for use in the
 105 portable file.  Its value is currently not used.
 106
 107 The MAP subcommand is currently ignored.
 108
 109 @cmd{EXPORT} is a procedure.  It causes the active file to be read.
 110
 111 @node GET
 112 @section GET
 113 @vindex GET
 114
 115 @display
 116 GET
 117         /FILE='filename'
 118         /DROP=var_list
 119         /KEEP=var_list
 120         /RENAME=(src_names=target_names)@dots{}
 121 @end display
 122
 123 @cmd{GET} clears the current dictionary and active file and
 124 replaces them with the dictionary and data from a specified system file.
 125
 126 The FILE subcommand is the only required subcommand.  Specify the system
 127 file to be read as a string file name or a file handle (@pxref{FILE
 128 HANDLE}).
 129
 130 By default, all the variables in a system file are read.  The DROP
 131 subcommand can be used to specify a list of variables that are not to be
 132 read.  By contrast, the KEEP subcommand can be used to specify variable
 133 that are to be read, with all other variables not read.
 134
 135 Normally variables in a system file retain the names that they were
 136 saved under.  Use the RENAME subcommand to change these names.  Specify,
 137 within parentheses, a list of variable names followed by an equals sign
 138 (@samp{=}) and the names that they should be renamed to.  Multiple
 139 parenthesized groups of variable names can be included on a single
 140 RENAME subcommand.  Variables' names may be swapped using a RENAME
 141 subcommand of the form @samp{/RENAME=(A B=B A)}.
 142
 143 Alternate syntax for the RENAME subcommand allows the parentheses to be
 144 eliminated.  When this is done, only a single variable may be renamed at
 145 once.  For instance, @samp{/RENAME=A=B}.  This alternate syntax is
 146 deprecated.
 147
 148 DROP, KEEP, and RENAME are performed in left-to-right order.  They
 149 each may be present any number of times.  @cmd{GET} never modifies a
 150 system file on disk.  Only the active file read from the system file
 151 is affected by these subcommands.
 152
 153 @cmd{GET} does not cause the data to be read, only the dictionary.  The data
 154 is read later, when a procedure is executed.
 155
 156 @node IMPORT
 157 @section IMPORT
 158 @vindex IMPORT
 159
 160 @display
 161 IMPORT
 162         /FILE='filename'
 163         /TYPE=@{COMM,TAPE@}
 164         /DROP=var_list
 165         /KEEP=var_list
 166         /RENAME=(src_names=target_names)@dots{}
 167 @end display
 168
 169 The @cmd{IMPORT} transformation clears the active file dictionary and
 170 data and
 171 replaces them with a dictionary and data from a portable file on disk.
 172
 173 The FILE subcommand, which is the only required subcommand, specifies
 174 the portable file to be read as a file name string or a file handle
 175 (@pxref{FILE HANDLE}).
 176
 177 The TYPE subcommand is currently not used.
 178
 179 DROP, KEEP, and RENAME follow the syntax used by @cmd{GET} (@pxref{GET}).
 180
 181 @cmd{IMPORT} does not cause the data to be read, only the dictionary.  The
 182 data is read later, when a procedure is executed.
 183
 184 @node MATCH FILES
 185 @section MATCH FILES
 186 @vindex MATCH FILES
 187
 188 @display
 189 MATCH FILES
 190         /@{FILE,TABLE@}=@{*,'filename'@}
 191         /DROP=var_list
 192         /KEEP=var_list
 193         /RENAME=(src_names=target_names)@dots{}
 194         /IN=var_name
 195
 196         /BY var_list
 197         /FIRST=var_name
 198         /LAST=var_name
 199         /MAP
 200 @end display
 201
 202 @cmd{MATCH FILES} merges one or more system files, optionally
 203 including the active file.  Records with the same values for BY
 204 variables are combined into a single record.  Records with different
 205 values are output in order.  Thus, multiple sorted system files are
 206 combined into a single sorted system file based on the value of the BY
 207 variables.  The results of the merge become the new active file.
 208
 209 The BY subcommand specifies a list of variables that are used to match
 210 records from each of the system files.  Variables specified must exist
 211 in all the files specified on FILE and TABLE.  BY should usually be
 212 specified.  If TABLE or IN is used then BY is required.
 213
 214 Specify FILE with a system file as a file name string or file handle
 215 (@pxref{FILE HANDLE}), or with an asterisk (@samp{*}) to
 216 indicate the current active file.  The files specified on FILE are
 217 merged together based on the BY variables, or combined case-by-case if
 218 BY is not specified.  Normally at least two FILE subcommands should be
 219 specified.
 220
 221 Specify TABLE with a system file to use it as a @dfn{table
 222 lookup file}.  Records in table lookup files are not used up after
 223 they've been used once.  This means that data in table lookup files can
 224 correspond to any number of records in FILE files.  Table lookup files
 225 correspond to lookup tables in traditional relational database systems.
 226 It is incorrect to have records with duplicate BY values in table lookup
 227 files.
 228
 229 Any number of FILE and TABLE subcommands may be specified.  Each
 230 instance of FILE or TABLE can be followed by any sequence of DROP,
 231 KEEP, or RENAME subcommands.  These have the same form and meaning as
 232 the corresponding subcommands of @cmd{GET} (@pxref{GET}), but apply
 233 only to variables in the given file.
 234
 235 Each FILE or TABLE may optionally be followed by an IN subcommand,
 236 which creates a numeric variable with the specified name and format
 237 F1.0.  The IN variable takes value 1 in a case if the given file
 238 contributed a row to the merged file, 0 otherwise.  The DROP, KEEP,
 239 and RENAME subcommands do not affect IN variables.
 240
 241 Variables belonging to files that are not present for the current case
 242 are set to the system-missing value for numeric variables or spaces for
 243 string variables.
 244
 245 FIRST, LAST, and MAP are currently ignored.
 246
 247 @cmd{MATCH FILES} may not be specified following @cmd{TEMPORARY}
 248 (@pxref{TEMPORARY}) if the active file is used as an input source.
 249
 250 @node SAVE
 251 @section SAVE
 252 @vindex SAVE
 253
 254 @display
 255 SAVE
 256         /OUTFILE='filename'
 257         /UNSELECTED=@{RETAIN,DELETE@}
 258         /@{COMPRESSED,UNCOMPRESSED@}
 259         /PERMISSIONS=@{WRITEABLE,READONLY@}
 260         /DROP=var_list
 261         /KEEP=var_list
 262         /VERSION=version
 263         /RENAME=(src_names=target_names)@dots{}
 264         /NAMES
 265         /MAP
 266 @end display
 267
 268 The @cmd{SAVE} procedure causes the dictionary and data in the active
 269 file to
 270 be written to a system file.
 271
 272 OUTFILE is the only required subcommand.  Specify the system
 273 file to be written as a string file name or a file handle (@pxref{FILE
 274 HANDLE}).
 275
 276 By default, cases excluded with FILTER are written to the system file.
 277 These can be excluded by specifying DELETE on the UNSELECTED
 278 subcommand.  Specifying RETAIN makes the default explicit.
 279
 280 The COMPRESS and UNCOMPRESS subcommand determine whether the saved
 281 system file is compressed.  By default, system files are compressed.
 282 This default can be changed with the SET command (@pxref{SET}).
 283
 284 The PERMISSIONS subcommand specifies permissions for the new system
 285 file.  WRITEABLE, the default, creates the file with read and write
 286 permission.  READONLY creates the file for read-only access.
 287
 288 By default, all the variables in the active file dictionary are written
 289 to the system file.  The DROP subcommand can be used to specify a list
 290 of variables not to be written.  In contrast, KEEP specifies variables
 291 to be written, with all variables not specified not written.
 292
 293 Normally variables are saved to a system file under the same names they
 294 have in the active file.  Use the RENAME subcommand to change these names.
 295 Specify, within parentheses, a list of variable names followed by an
 296 equals sign (@samp{=}) and the names that they should be renamed to.
 297 Multiple parenthesized groups of variable names can be included on a
 298 single RENAME subcommand.  Variables' names may be swapped using a
 299 RENAME subcommand of the form @samp{/RENAME=(A B=B A)}.
 300
 301 Alternate syntax for the RENAME subcommand allows the parentheses to be
 302 eliminated.  When this is done, only a single variable may be renamed at
 303 once.  For instance, @samp{/RENAME=A=B}.  This alternate syntax is
 304 deprecated.
 305
 306 DROP, KEEP, and RENAME are performed in left-to-right order.  They
 307 each may be present any number of times.  @cmd{SAVE} never modifies
 308 the active file.  DROP, KEEP, and RENAME only affect the system file
 309 written to disk.
 310
 311 The VERSION subcommand specifies the version of the file format. Valid
 312 versions are 2 and 3.  The default version is 3.  In version 2 system
 313 files, variable names longer than 8 bytes will be truncated.  The two
 314 versions are otherwise identical.
 315
 316 The NAMES and MAP subcommands are currently ignored.
 317
 318 @cmd{SAVE} causes the data to be read.  It is a procedure.
 319
 320 @node SYSFILE INFO
 321 @section SYSFILE INFO
 322 @vindex SYSFILE INFO
 323
 324 @display
 325 SYSFILE INFO FILE='filename'.
 326 @end display
 327
 328 @cmd{SYSFILE INFO} reads the dictionary in a system file and
 329 displays the information in its dictionary.
 330
 331 Specify a file name or file handle.  @cmd{SYSFILE INFO} reads that file as
 332 a system file and displays information on its dictionary.
 333
 334 @cmd{SYSFILE INFO} does not affect the current active file.
 335
 336 @node XEXPORT
 337 @section XEXPORT
 338 @vindex XEXPORT
 339
 340 @display
 341 EXPORT
 342         /OUTFILE='filename'
 343         /DIGITS=n
 344         /DROP=var_list
 345         /KEEP=var_list
 346         /RENAME=(src_names=target_names)@dots{}
 347         /TYPE=@{COMM,TAPE@}
 348         /MAP
 349 @end display
 350
 351 The @cmd{EXPORT} transformation writes the active file dictionary and
 352 data to a specified portable file.
 353
 354 This transformation is a PSPP extension.
 355
 356 It is similar to the @cmd{EXPORT} procedure, with two differences:
 357
 358 @itemize
 359 @item
 360 @cmd{XEXPORT} is a transformation, not a procedure.  It is executed when
 361 the data is read by a procedure or procedure-like command.
 362
 363 @item
 364 @cmd{XEXPORT} does not support the UNSELECTED subcommand.
 365 @end itemize
 366
 367 @xref{EXPORT}, for more information.
 368
 369 @node XSAVE,  , XEXPORT, System and Portable Files
 370 @section XSAVE
 371 @vindex XSAVE
 372
 373 @display
 374 XSAVE
 375         /OUTFILE='filename'
 376         /@{COMPRESSED,UNCOMPRESSED@}
 377         /PERMISSIONS=@{WRITEABLE,READONLY@}
 378         /DROP=var_list
 379         /KEEP=var_list
 380         /VERSION=version
 381         /RENAME=(src_names=target_names)@dots{}
 382         /NAMES
 383         /MAP
 384 @end display
 385
 386 The @cmd{XSAVE} transformation writes the active file dictionary and
 387 data to a system file stored on disk.  It is similar to the @cmd{SAVE}
 388 procedure, with two differences:
 389
 390 @itemize
 391 @item
 392 @cmd{XSAVE} is a transformation, not a procedure.  It is executed when
 393 the data is read by a procedure or procedure-like command.
 394
 395 @item
 396 @cmd{XSAVE} does not support the UNSELECTED subcommand.
 397 @end itemize
 398
 399 @xref{SAVE}, for more information.
 400 @setfilename ignored