X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Ffiles.texi;h=ffbb685c89c955fdb852923850c3eff37e3b0010;hb=refs%2Fheads%2Fmdd;hp=6b3a78c75b6d6f5c0aa25943830d8320956f62b0;hpb=e0701896ff3fcdc18a26ca1881d8c657833dad77;p=pspp diff --git a/doc/files.texi b/doc/files.texi index 6b3a78c75b..ffbb685c89 100644 --- a/doc/files.texi +++ b/doc/files.texi @@ -1,3 +1,12 @@ +@c PSPP - a program for statistical analysis. +@c Copyright (C) 2017 Free Software Foundation, Inc. +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.3 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". +@c @node System and Portable File IO @chapter System and Portable File I/O @@ -11,6 +20,7 @@ portable files. * GET DATA:: Read from foreign files. * IMPORT:: Read from a portable file. * SAVE:: Write to a system file. +* SAVE DATA COLLECTION:: Write to a system file and metadata file. * SAVE TRANSLATE:: Write data in foreign file formats. * SYSFILE INFO:: Display system file dictionary. * XEXPORT:: Write to a portable file, as a transformation. @@ -370,7 +380,7 @@ GET DATA /TYPE=TXT [ENCODING='@var{encoding}'] [/ARRANGEMENT=@{DELIMITED,FIXED@}] [/FIRSTCASE=@{@var{first_case}@}] - [/IMPORTCASE=@{ALL,FIRST @var{max_cases},PERCENT @var{percent}@}] + [/IMPORTCASES=...] @dots{}additional subcommands depending on ARRANGEMENT@dots{} @end display @@ -398,19 +408,13 @@ line. To skip lines at the beginning of an input file, set @subcmd{FIRSTCASE} to the number of the first line to read: 2 to skip the first line, 3 to skip the first two lines, and so on. -@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 @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 -number of cases in some kinds of unusual files cannot be estimated; -@pspp{} will read all cases in such files.) +@subcmd{IMPORTCASES} is ignored, for compatibility. Use @cmd{N OF +CASES} to limit the number of cases read from a file (@pxref{N OF +CASES}), or @cmd{SAMPLE} to obtain a random sample of cases +(@pxref{SAMPLE}). -@subcmd{FIRSTCASE} and @subcmd{IMPORTCASE} may be used with delimited and fixed-format -data. The remaining subcommands, which apply only to one of the two file -arrangements, are described below. +The remaining subcommands apply only to one of the two file +arrangements, described below. @menu * GET DATA /TYPE=TXT /ARRANGEMENT=DELIMITED:: @@ -767,6 +771,44 @@ The @subcmd{NAMES} and @subcmd{MAP} subcommands are currently ignored. @cmd{SAVE} causes the data to be read. It is a procedure. +@node SAVE DATA COLLECTION +@section SAVE DATA COLLECTION +@vindex SAVE DATA COLLECTION + +@display +SAVE DATA COLLECTION + /OUTFILE=@{'@var{file_name}',@var{file_handle}@} + /METADATA=@{'@var{file_name}',@var{file_handle}@} + /@{UNCOMPRESSED,COMPRESSED,ZCOMPRESSED@} + /PERMISSIONS=@{WRITEABLE,READONLY@} + /DROP=@var{var_list} + /KEEP=@var{var_list} + /VERSION=@var{version} + /RENAME=(@var{src_names}=@var{target_names})@dots{} + /NAMES + /MAP +@end display + +Like @cmd{SAVE}, @cmd{SAVE DATA COLLECTION} writes the dictionary and +data in the active dataset to a system file. In addition, it writes +metadata to an additional XML metadata file. + +OUTFILE is required. Specify the system file to be written as a +string file name or a file handle (@pxref{File Handles}). + +METADATA is also required. Specify the metadata file to be written as +a string file name or a file handle. Metadata files customarily use a +@file{.mdd} extension. + +The current implementation of this command only outputs an +approximation of the metadata file format. Please report bugs. + +Other subcommands are optional. They have the same meanings as in the +@cmd{SAVE} command. + +@cmd{SAVE DATA COLLECTION} causes the data to be read. It is a +procedure. + @node SAVE TRANSLATE @section SAVE TRANSLATE @vindex SAVE TRANSLATE @@ -811,13 +853,15 @@ values as if they were not missing. Specify MISSING=RECODE to output numeric user-missing values like system-missing values and string user-missing values as all spaces. -By default, all the variables in the active dataset dictionary are saved -to the system file, but @subcmd{DROP} or @subcmd{KEEP} can select a subset of variable -to save. The @subcmd{RENAME} subcommand can also be used to change the names -under which variables are saved. @subcmd{UNSELECTED} determines whether cases -filtered out by the @cmd{FILTER} command are written to the output file. -These subcommands have the same syntax and meaning as on the -@cmd{SAVE} command (@pxref{SAVE}). +By default, all the variables in the active dataset dictionary are +saved to the system file, but @subcmd{DROP} or @subcmd{KEEP} can +select a subset of variable to save. The @subcmd{RENAME} subcommand +can also be used to change the names under which variables are saved; +because they are used only in the output, these names do not have to +conform to the usual PSPP variable naming rules. @subcmd{UNSELECTED} +determines whether cases filtered out by the @cmd{FILTER} command are +written to the output file. These subcommands have the same syntax +and meaning as on the @cmd{SAVE} command (@pxref{SAVE}). Each supported file type has additional subcommands, explained in separate sections below. @@ -942,7 +986,7 @@ XEXPORT /MAP @end display -The @cmd{EXPORT} transformation writes the active dataset dictionary and +The @cmd{XEXPORT} transformation writes the active dataset dictionary and data to a specified portable file. This transformation is a @pspp{} extension.