Documentation: Yet more markup
[pspp] / doc / statistics.texi
index f8a8864da75e2c7db9990a93d94e542cc6797835..0ae3d3786258ee0963728fb95b69d34ec52a0b15 100644 (file)
@@ -51,17 +51,18 @@ variables to be analyzed.  Keyword @subcmd{VARIABLES} is optional.
 All other subcommands are optional:
 
 The @subcmd{MISSING} subcommand determines the handling of missing variables.  If
-INCLUDE is set, then user-missing values are included in the
-calculations.  If NOINCLUDE is set, which is the default, user-missing
-values are excluded.  If VARIABLE is set, then missing values are
-excluded on a variable by variable basis; if LISTWISE is set, then
+@subcmd{INCLUDE} is set, then user-missing values are included in the
+calculations.  If @subcmd{NOINCLUDE} is set, which is the default, user-missing
+values are excluded.  If @subcmd{VARIABLE} is set, then missing values are
+excluded on a variable by variable basis; if @subcmd{LISTWISE} is set, then
 the entire case is excluded whenever any value in that case has a
-system-missing or, if INCLUDE is set, user-missing value.
+system-missing or, if @subcmd{INCLUDE} is set, user-missing value.
 
 The @subcmd{FORMAT} subcommand affects the output format.  Currently the
-LABELS/NOLABELS and NOINDEX/INDEX settings are not used.  When SERIAL is
+@subcmd{LABELS/NOLABELS} and @subcmd{NOINDEX/INDEX} settings are not used.
+When @subcmd{SERIAL} is
 set, both valid and missing number of cases are listed in the output;
-when NOSERIAL is set, only valid cases are listed.
+when @subcmd{NOSERIAL} is set, only valid cases are listed.
 
 The @subcmd{SAVE} subcommand causes @cmd{DESCRIPTIVES} to calculate Z scores for all
 the specified variables.  The Z scores are saved to new variables.
@@ -69,7 +70,7 @@ Variable names are generated by trying first the original variable name
 with Z prepended and truncated to a maximum of 8 characters, then the
 names ZSC000 through ZSC999, STDZ00 through STDZ09, ZZZZ00 through
 ZZZZ09, ZQZQ00 through ZQZQ09, in that sequence.  In addition, Z score
-variable names can be specified explicitly on VARIABLES in the variable
+variable names can be specified explicitly on @subcmd{VARIABLES} in the variable
 list by enclosing them in parentheses after each variable.
 
 The @subcmd{STATISTICS} subcommand specifies the statistics to be displayed:
@@ -106,11 +107,11 @@ Standard error of the skewness.
 @end table
 
 The @subcmd{SORT} subcommand specifies how the statistics should be sorted.  Most
-of the possible values should be self-explanatory.  NAME causes the
+of the possible values should be self-explanatory.  @subcmd{NAME} causes the
 statistics to be sorted by name.  By default, the statistics are listed
-in the order that they are specified on the @subcmd{VARIABLES} subcommand.  The A
-and D settings request an ascending or descending sort order,
-respectively.
+in the order that they are specified on the @subcmd{VARIABLES} subcommand.
+The @subcmd{A} and @subcmd{D} settings request an ascending or descending
+sort order, respectively.
 
 @node FREQUENCIES
 @section FREQUENCIES
@@ -166,13 +167,14 @@ respectively, by frequency count.
 @end itemize
 
 The @subcmd{MISSING} subcommand controls the handling of user-missing values.
-When EXCLUDE, the default, is set, user-missing values are not included
-in frequency tables or statistics.  When INCLUDE is set, user-missing
+When @subcmd{EXCLUDE}, the default, is set, user-missing values are not included
+in frequency tables or statistics.  When @subcmd{INCLUDE} is set, user-missing
 are included.  System-missing values are never included in statistics,
 but are listed in frequency tables.
 
-The available STATISTICS are the same as available in @cmd{DESCRIPTIVES}
-(@pxref{DESCRIPTIVES}), with the addition of MEDIAN, the data's median
+The available @subcmd{STATISTICS} are the same as available 
+in @cmd{DESCRIPTIVES} (@pxref{DESCRIPTIVES}), with the addition 
+of @subcmd{MEDIAN}, the data's median
 value, and MODE, the mode.  (If there are multiple modes, the smallest
 value is reported.)  By default, the mean, standard deviation of the
 mean, minimum, and maximum are reported for each variable.
@@ -238,14 +240,14 @@ normal distribution, and for finding outliers and extreme values.
 The @subcmd{VARIABLES} subcommand is mandatory.  
 It specifies the dependent variables and optionally variables to use as
 factors for the analysis.
-Variables listed before the first BY keyword (if any) are the 
+Variables listed before the first @subcmd{BY} keyword (if any) are the 
 dependent variables.
 The dependent variables may optionally be followed by a list of
 factors which tell @pspp{} how to break down the analysis for each
 dependent variable. 
 
 Following the dependent variables, factors may be specified.
-The factors (if desired) should be preceeded by a single BY keyword.
+The factors (if desired) should be preceeded by a single @subcmd{BY} keyword.
 The format for each factor is 
 @display
 @var{factorvar} [BY @var{subfactorvar}].
@@ -317,7 +319,7 @@ calculation of the descriptives command.  The default is 95%.
 The @subcmd{PERCENTILES} subcommand specifies which percentiles are to be calculated, 
 and which algorithm to use for calculating them.  The default is to
 calculate the 5, 10, 25, 50, 75, 90, 95 percentiles using the
-HAVERAGE algorithm.
+@subcmd{HAVERAGE} algorithm.
 
 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,
@@ -394,15 +396,15 @@ CORRELATIONS
 The @cmd{CORRELATIONS} procedure produces tables of the Pearson correlation coefficient
 for a set of variables.  The significance of the coefficients are also given.
 
-At least one @subcmd{VARIABLES} subcommand is required. If the WITH keyword is used, then a non-square
-correlation table will be produced.
-The variables preceding WITH, will be used as the rows of the table, and the variables following
-will be the columns of the table.
+At least one @subcmd{VARIABLES} subcommand is required. If the @subcmd{WITH} 
+keyword is used, then a non-square correlation table will be produced.
+The variables preceding @subcmd{WITH}, will be used as the rows of the table,
+and the variables following will be the columns of the table.
 If no @subcmd{WITH} subcommand is given, then a square, symmetrical table using all variables is produced.
 
 
 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 @subcmd{EXCLUDE} is set, which is the default, user-missing
 values are excluded as well as system-missing values. 
@@ -426,13 +428,13 @@ If @subcmd{SIG} is specified, then no highlighting is performed.  This is the de
 
 @cindex covariance
 The @subcmd{STATISTICS} subcommand requests additional statistics to be displayed.  The keyword 
-DESCRIPTIVES requests that the mean, number of non-missing cases, and the non-biased
+@subcmd{DESCRIPTIVES} requests that the mean, number of non-missing cases, and the non-biased
 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 @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 @subcmd{DESCRIPTIVES} and @subcmd{XPROD}.
+The keyword @subcmd{ALL} is the union of @subcmd{DESCRIPTIVES} and @subcmd{XPROD}.
 
 @node CROSSTABS
 @section CROSSTABS
@@ -483,9 +485,9 @@ In general mode, numeric and string variables may be specified on
 TABLES.  In integer mode, only numeric variables are allowed.
 
 The @subcmd{MISSING} subcommand determines the handling of user-missing values.
-When set to TABLE, the default, missing values are dropped on a table by
-table basis.  When set to INCLUDE, user-missing values are included in
-tables and statistics.  When set to REPORT, which is allowed only in
+When set to @subcmd{TABLE}, the default, missing values are dropped on a table by
+table basis.  When set to @subcmd{INCLUDE}, user-missing values are included in
+tables and statistics.  When set to @subcmd{REPORT}, which is allowed only in
 integer mode, user-missing values are included in tables but marked with
 an @samp{M} (for ``missing'') and excluded from statistical
 calculations.
@@ -496,10 +498,10 @@ The @subcmd{FORMAT} subcommand controls the characteristics of the
 crosstabulation tables to be displayed.  It has a number of possible
 settings:
 
-@itemize @subcmd{}
+@itemize @asis
 @item
-TABLES, the default, causes crosstabulation tables to be output.
-NOTABLES suppresses them.
+@subcmd{TABLES}, the default, causes crosstabulation tables to be output.
+@subcmd{NOTABLES} suppresses them.
 
 @item
 @subcmd{PIVOT}, the default, causes each @subcmd{TABLES} subcommand to be displayed in a
@@ -544,7 +546,8 @@ Suppress cells entirely.
 @end table
 
 @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}
+@subcmd{COLUMN}, and @subcmd{TOTAL}.  
+If @subcmd{CELLS} is not specified at all then only @subcmd{COUNT}
 will be selected.
 
 The @subcmd{STATISTICS} subcommand selects statistics for computation:
@@ -593,7 +596,7 @@ some statistics are calculated only in integer mode.
 @samp{/STATISTICS} without any settings selects CHISQ.  If the
 @subcmd{STATISTICS} subcommand is not given, no statistics are calculated.
 
-@strong{Please note:} Currently the implementation of CROSSTABS has the
+@strong{Please note:} Currently the implementation of @cmd{CROSSTABS} has the
 followings bugs:
 
 @itemize @bullet
@@ -644,18 +647,19 @@ FACTOR  VARIABLES=@var{var_list}
         [ /MISSING=[@{LISTWISE, PAIRWISE@}] [@{INCLUDE, EXCLUDE@}] ]
 @end display
 
-The FACTOR command performs Factor Analysis or Principal Axis Factoring on a dataset.  It may be used to find
+The @cmd{FACTOR} command performs Factor Analysis or Principal Axis Factoring on a dataset.  It may be used to find
 common factors in the data or for data reduction purposes.
 
 The @subcmd{VARIABLES} subcommand is required.  It lists the variables which are to partake in the analysis.
 
 The @subcmd{/EXTRACTION} subcommand is used to specify the way in which factors (components) are extracted from the data.
-If PC is specified, then Principal Components Analysis is used.  If PAF is specified, then Principal Axis Factoring is
+If @subcmd{PC} is specified, then Principal Components Analysis is used.  
+If @subcmd{PAF} is specified, then Principal Axis Factoring is
 used. By default Principal Components Analysis will be used.
 
 The @subcmd{/ROTATION} subcommand is used to specify the method by which the extracted solution will be rotated.
-Three methods are available: VARIMAX (which is the default), EQUAMAX, and QUARTIMAX.
-If don't want any rotation to be performed, the word NOROTATE will prevent the command from performing any
+Three methods are available: @subcmd{VARIMAX} (which is the default), @subcmd{EQUAMAX}, and @subcmd{QUARTIMAX}.
+If don't want any rotation to be performed, the word @subcmd{NOROTATE} will prevent the command from performing any
 rotation on the data. Oblique rotations are not supported.
 
 The @subcmd{/METHOD} subcommand should be used to determine whether the covariance matrix or the correlation matrix of the data is
@@ -685,15 +689,15 @@ The @subcmd{/PRINT} subcommand may be used to select which features of the analy
 @item ALL
       All of the above are printed.
 @item DEFAULT
-      Identical to INITIAL and EXTRACTION.
+      Identical to @subcmd{INITIAL} and @subcmd{EXTRACTION}.
 @end itemize
 
 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
-are sorted in descending order of significance.  If BLANK(@var{n}) is specified, then coefficients whose absolute value is less
-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 
+The @subcmd{/FORMAT} subcommand determined how data are to be displayed in loading matrices.  If @subcmd{SORT} is specified, then the variables
+are sorted in descending order of significance.  If @subcmd{BLANK(@var{n})} is specified, then coefficients whose absolute value is less
+than @var{n} will not be printed.  If the keyword @subcmd{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.
@@ -1522,7 +1526,7 @@ more variables whose values are to be ranked.
 After each variable, @samp{A} or @samp{D} may appear, indicating that
 the variable is to be ranked in ascending or descending order.
 Ascending is the default.
-If a BY keyword appears, it should be followed by a list of variables
+If a @subcmd{BY} keyword appears, it should be followed by a list of variables
 which are to serve as group variables.  
 In this case, the cases are gathered into groups, and ranks calculated
 for each group.
@@ -1531,7 +1535,7 @@ The @subcmd{TIES} subcommand specifies how tied values are to be treated.  The
 default is to take the mean value of all the tied cases.
 
 The @subcmd{FRACTION} subcommand specifies how proportional ranks are to be
-calculated.  This only has any effect if NORMAL or PROPORTIONAL rank
+calculated.  This only has any effect if @subcmd{NORMAL} or @subcmd{PROPORTIONAL} rank
 functions are requested.
 
 The @subcmd{PRINT} subcommand may be used to specify that a summary of the rank