X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Ftransformation.texi;h=1ca2d22b297ba0727c1d089532ad3ac9312a14f4;hb=b78aa5f6c822c055d1c3e98cb868c17070402799;hp=960e782a0cef785363a77974e118c3f0704b98d9;hpb=1b1837591924226078c96db15888b68beec2ef6d;p=pspp diff --git a/doc/transformation.texi b/doc/transformation.texi index 960e782a0c..1ca2d22b29 100644 --- a/doc/transformation.texi +++ b/doc/transformation.texi @@ -42,9 +42,9 @@ handle (@pxref{File Handles}), or a dataset by its name (@pxref{Datasets}). The aggregated cases are written to this file. If @samp{*} is specified, then the aggregated cases replace the active dataset's data. -Use of OUTFILE to write a portable file is a @pspp{} extension. +Use of @subcmd{OUTFILE} to write a portable file is a @pspp{} extension. -If OUTFILE=@samp{*} is given, then the subcommand MODE may also be +If @subcmd{OUTFILE=*} is given, then the subcommand @subcmd{MODE} may also be specified. 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 @@ -100,110 +100,112 @@ list. Each set must have exactly as many source variables as aggregation variables. Each aggregation variable receives the results of applying the specified aggregation function to the corresponding source -variable. The MEAN, MEDIAN, SD, and SUM aggregation functions may only be +variable. The @subcmd{MEAN}, @subcmd{MEDIAN}, @subcmd{SD}, and @subcmd{SUM} +aggregation functions may only be applied to numeric variables. All the rest may be applied to numeric and string variables. The available aggregation functions are as follows: @table @asis -@item FGT(@var{var_name}, @var{value}) +@item @subcmd{FGT(@var{var_name}, @var{value})} Fraction of values greater than the specified constant. The default format is F5.3. -@item FIN(@var{var_name}, @var{low}, @var{high}) +@item @subcmd{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{var_name}, @var{value}) +@item @subcmd{FLT(@var{var_name}, @var{value})} Fraction of values less than the specified constant. The default format is F5.3. -@item FIRST(@var{var_name}) +@item @subcmd{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 @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{var_name}, @var{low}, @var{high}) +@item @subcmd{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{var_name}) +@item @subcmd{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 @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{var_name}) +@item @subcmd{MAX(@var{var_name})} Maximum value. The aggregation variable receives the complete dictionary information from the source variable. -@item MEAN(@var{var_name}) +@item @subcmd{MEAN(@var{var_name})} Arithmetic mean. Limited to numeric values. The default format is F8.2. -@item MEDIAN(@var{var_name}) +@item @subcmd{MEDIAN(@var{var_name})} The median value. Limited to numeric values. The default format is F8.2. -@item MIN(@var{var_name}) +@item @subcmd{MIN(@var{var_name})} Minimum value. The aggregation variable receives the complete dictionary information from the source variable. -@item N(@var{var_name}) +@item @subcmd{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}). -@item N +@item @subcmd{N} 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{var_name}) +@item @subcmd{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{var_name}) +@item @subcmd{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. -@item NU +@item @subcmd{NU} Number of cases aggregated to form this group. Each case is considered to have a weight of 1, regardless of the current weighting variable. The default format is F7.0. -@item NUMISS(@var{var_name}) +@item @subcmd{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{var_name}, @var{value}) +@item @subcmd{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{var_name}, @var{low}, @var{high}) +@item @subcmd{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{var_name}, @var{value}) +@item @subcmd{PLT(@var{var_name}, @var{value})} Percentage of values less than the specified constant. The default format is F5.1. -@item POUT(@var{var_name}, @var{low}, @var{high}) +@item @subcmd{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{var_name}) +@item @subcmd{SD(@var{var_name})} Standard deviation of the mean. Limited to numeric values. The default format is F8.2. -@item SUM(var_name) +@item @subcmd{SUM(@var{var_name})} Sum. Limited to numeric values. The default format is F8.2. @end table Aggregation functions compare string values in terms of internal -character codes. On most modern computers, this is a form of ASCII. +character codes. +On most modern computers, this is @acronym{ASCII} or a superset thereof. The aggregation functions listed above exclude all user-missing values from calculations. To include user-missing values, insert a period @@ -240,18 +242,18 @@ By default, increasing values of a source variable (for a string, this is based on character code comparisons) are recoded to increasing values of its target variable. To cause increasing values of a source variable to be recoded to decreasing values of its target variable (@var{n} down -to 1), specify DESCENDING. +to 1), specify @subcmd{DESCENDING}. -PRINT is currently ignored. +@subcmd{PRINT} is currently ignored. The @subcmd{GROUP} subcommand is relevant only if more than one variable is to be recoded. It causes a single mapping between source and target values to be used, instead of one map per variable. -If /BLANK=MISSING is given, then string variables which contain only -whitespace are recoded as SYSMIS. If /BLANK=VALID is given then they -will be allocated a value like any other. /BLANK is not relevant -to numeric values. /BLANK=VALID is the default. +If @subcmd{/BLANK=MISSING} is given, then string variables which contain only +whitespace are recoded as SYSMIS. If @subcmd{/BLANK=VALID} is given then they +will be allocated a value like any other. @subcmd{/BLANK} is not relevant +to numeric values. @subcmd{/BLANK=VALID} is the default. @cmd{AUTORECODE} is a procedure. It causes the data to be read. @@ -310,8 +312,8 @@ Each @var{value} takes one of the following forms: @var{num1} THRU @var{num2} MISSING SYSMIS -In addition, @var{num1} and @var{num2} can be LO or LOWEST, or HI or HIGHEST, -respectively. +where @var{num1} is a numeric expression or the words @subcmd{LO} or @subcmd{LOWEST} + and @var{num2} is a numeric expression or @subcmd{HI} or @subcmd{HIGHEST}. @end display @cmd{COUNT} creates or replaces a numeric @dfn{target} variable that @@ -327,11 +329,11 @@ User-missing values of test variables are treated just like any other values. They are @strong{not} treated as system-missing values. User-missing values that are criterion values or inside ranges of criterion values are counted as any other values. However (for numeric -variables), keyword MISSING may be used to refer to all system- +variables), keyword @subcmd{MISSING} may be used to refer to all system- and user-missing values. @cmd{COUNT} target variables are assigned values in the order -specified. In the command @code{COUNT @var{A}=@var{A} @var{B}(1) /@var{B}=@var{A} @var{B}(2).}, the +specified. In the command @subcmd{COUNT @var{A}=@var{A} @var{B}(1) /@var{B}=@var{A} @var{B}(2).}, the following actions occur: @itemize @minus @@ -504,7 +506,7 @@ RECODE @var{src_vars} [INTO @var{dest_vars}]. @end display -Following the RECODE keyword itself comes @var{src_vars} which is a list +Following the @cmd{RECODE} keyword itself comes @var{src_vars} which is a list of variables whose values are to be transformed. These variables may be string variables or they may be numeric. However the list must be homogeneous; you may not mix string variables and @@ -517,7 +519,7 @@ The source values are used to specify the values in the dataset which need to change, and the destination value specifies the new value to which they should be changed. Each @var{src_value} may take one of the following forms: -@itemize @bullet +@table @asis @item @var{number} If the source variables are numeric then @var{src_value} may be a literal number. @@ -526,11 +528,9 @@ If the source variables are string variables then @var{src_value} may be a literal string (like all strings, enclosed in single or double quotes). @item @var{num1} THRU @var{num2} This form is valid only when the source variables are numeric. -It specifies all values in the range [@var{num1}, @var{num2}]. -Normally you would ensure that @var{num2} is greater than or equal to -@var{num1}. -If @var{num1} however is greater than @var{num2}, then the range -[@var{num2},@var{num1}] will be used instead. +It specifies all values in the range between @var{num1} and @var{num2}, +including both endpoints of the range. By convention, @var{num1} +should be less than @var{num2}. Open-ended ranges may be specified using @samp{LO} or @samp{LOWEST} for @var{num1} or @samp{HI} or @samp{HIGHEST} for @var{num2}. @@ -547,11 +547,11 @@ The @samp{ELSE} keyword may be used to match any values which are not matched by any other @var{src_value} appearing in the command. If this keyword appears, it should be used in the last mapping of the command. -@end itemize +@end table After the source variables comes an @samp{=} and then the @var{dest_value}. The @var{dest_value} may take any of the following forms: -@itemize @bullet +@table @asis @item @var{number} A literal numeric value to which the source values should be changed. This implies the destination variable must be numeric. @@ -567,7 +567,7 @@ The special keyword @samp{COPY} means that the source value should not be modified, but copied directly to the destination value. This is meaningful only if @samp{INTO @var{dest_vars}} is specified. -@end itemize +@end table Mappings are considered from left to right. Therefore, if a value is matched by a @var{src_value} from more than @@ -579,13 +579,17 @@ The behaviour of the command is slightly different depending on whether it appears or not. If @samp{INTO @var{dest_vars}} does not appear, then values will be recoded -``in place´´. This means that the recoded values are written back to the +``in place''. +This means that the recoded values are written back to the source variables from whence the original values came. In this case, the @var{dest_value} for every mapping must imply a value which has the same type as the @var{src_value}. For example, if the source value is a string value, it is not permissible for @var{dest_value} to be @samp{SYSMIS} or another forms which implies a numeric result. +It is also not permissible for @var{dest_value} to be longer than the width +of the source variable. + The following example two numeric variables @var{x} and @var{y} are recoded in place. Zero is recoded to 99, the values 1 to 10 inclusive are unchanged, @@ -668,7 +672,7 @@ recode @end example @noindent Here we have two recodings. The first affects the source variable @var{a} and recodes in-place the value 2 into 22 and all other values to 99. -The second recoding copies the values of @var{b} into the the variable @var{z}, +The second recoding copies the values of @var{b} into the variable @var{z}, changing any instances of 1 into 3. @node SORT CASES