docs

[pspp] / doc / statistics.texi

diff --git a/doc/statistics.texi b/doc/statistics.texi
index 1b0a294218608be25f11f92e67b935472d8b9824..30e0b3dd038cc579488f5b3ebdae0ac30de4a216 100644 (file)
--- a/doc/statistics.texi
+++ b/doc/statistics.texi
@@ -1155,8 +1155,6 @@ sets.
 @node CTABLES Data Summarization
 @subsection Data Summarization
 
 @node CTABLES Data Summarization
 @subsection Data Summarization
 

-@c TODO Summary function default formats
-

 The @code{CTABLES} command allows the user to control how the data are
 summarized with @dfn{summary specifications}, syntax that lists one or
 more summary function names, optionally separated by commas, and which
 The @code{CTABLES} command allows the user to control how the data are
 summarized with @dfn{summary specifications}, syntax that lists one or
 more summary function names, optionally separated by commas, and which


@@ -1188,6 +1186,31 @@ CTABLES /TABLE=AgeGroup [COLPCT 'Gender %' PCT5.0,
 @end example
 @psppoutput {ctables11}
 
 @end example
 @psppoutput {ctables11}
 

+In addition to the standard formats, @code{CTABLES} allows the user to
+specify the following special formats:
+
+@multitable {@code{NEGPAREN@i{w}.@i{d}}} {Encloses all numbers in parentheses.} {@t{(42.96%)}} {@t{(-42.96%)}}
+@item @code{NEGPAREN@i{w}.@i{d}}
+@tab Encloses negative numbers in parentheses.
+@tab @t{@w{    }42.96}
+@tab @t{@w{  }(42.96)}
+
+@item @code{NEQUAL@i{w}.@i{d}}
+@tab Adds a @code{N=} prefix.
+@tab @t{@w{  }N=42.96}
+@tab @t{@w{ }N=-42.96}
+
+@item @code{@code{PAREN@i{w}.@i{d}}}
+@tab Encloses all numbers in parentheses.
+@tab @t{@w{  }(42.96)}
+@tab @t{@w{ }(-42.96)}
+
+@item @code{PCTPAREN@i{w}.@i{d}}
+@tab Encloses all numbers in parentheses with a @samp{%} suffix.
+@tab @t{@w{ }(42.96%)}
+@tab @t{(-42.96%)}
+@end multitable
+

 Parentheses provide a shorthand to apply summary specifications to
 multiple variables.  For example, both of these commands:
 
 Parentheses provide a shorthand to apply summary specifications to
 multiple variables.  For example, both of these commands:
 


@@ -1201,7 +1224,10 @@ produce the same output shown below:
 
 @psppoutput {ctables12}
 
 
 @psppoutput {ctables12}
 

-The following sections list the available summary functions.
+The following sections list the available summary functions.  After
+each function's name is given its default label and format.  If no
+format is listed, then the default format is the print format for the
+variable being summarized.

 
 @menu
 * CTABLES Summary Functions for Individual Cells::
 
 @menu
 * CTABLES Summary Functions for Individual Cells::


@@ -1218,7 +1244,7 @@ individual cell in @code{CTABLES}.  Only one such summary function,
 @code{COUNT}, may be applied to both categorical and scale variables:
 
 @table @asis
 @code{COUNT}, may be applied to both categorical and scale variables:
 
 @table @asis

-@item @code{COUNT} (``Count'')
+@item @code{COUNT} (``Count'', F40.0)

 The sum of weights in a cell.
 
 If @code{CATEGORIES} for one or more of the variables in a table
 The sum of weights in a cell.
 
 If @code{CATEGORIES} for one or more of the variables in a table


@@ -1268,7 +1294,7 @@ The standard deviation.
 @item @code{SUM} (``Sum'')
 The sum.
 
 @item @code{SUM} (``Sum'')
 The sum.
 

-@item @code{TOTALN} (``Total N'')
+@item @code{TOTALN} (``Total N'', F40.0)

 The sum of weights in a cell.
 
 For scale data, @code{COUNT} and @code{TOTALN} are the same.
 The sum of weights in a cell.
 
 For scale data, @code{COUNT} and @code{TOTALN} are the same.


@@ -1280,7 +1306,7 @@ Options}), or user-missing values excluded because
 @code{MISSING=EXCLUDE} is in effect on @code{CATEGORIES}, or
 system-missing values.  @code{COUNT} does not count these.
 
 @code{MISSING=EXCLUDE} is in effect on @code{CATEGORIES}, or
 system-missing values.  @code{COUNT} does not count these.
 

-@item @code{VALIDN} (``Valid N'')
+@item @code{VALIDN} (``Valid N'', F40.0)

 The sum of valid count weights in included categories.
 
 @code{VALIDN} does not count missing values regardless of whether they
 The sum of valid count weights in included categories.
 
 @code{VALIDN} does not count missing values regardless of whether they


@@ -1341,13 +1367,13 @@ each @var{area} described above, for both categorical and scale
 variables:
 
 @table @asis
 variables:
 
 @table @asis

-@item @code{@i{area}PCT} or @code{@i{area}PCT.COUNT} (``@i{Area} %'')
+@item @code{@i{area}PCT} or @code{@i{area}PCT.COUNT} (``@i{Area} %'', PCT40.1)

 A percentage of total counts within @var{area}.
 
 A percentage of total counts within @var{area}.
 

-@item @code{@i{area}PCT.VALIDN} (``@i{Area} Valid N %'')
+@item @code{@i{area}PCT.VALIDN} (``@i{Area} Valid N %'', PCT40.1)

 A percentage of total counts for valid values within @var{area}.
 
 A percentage of total counts for valid values within @var{area}.
 

-@item @code{@i{area}PCT.TOTALN} (``@i{Area} Total N %'')
+@item @code{@i{area}PCT.TOTALN} (``@i{Area} Total N %'', PCT40.1)

 A percentage of total counts for all values within @var{area}.
 @end table
 
 A percentage of total counts for all values within @var{area}.
 @end table
 


@@ -1355,7 +1381,7 @@ Scale variables and totals and subtotals for categorical variables may
 use the following additional group cell summary function:
 
 @table @asis
 use the following additional group cell summary function:
 
 @table @asis

-@item @code{@i{area}PCT.SUM} (``@i{Area} Sum %'')
+@item @code{@i{area}PCT.SUM} (``@i{Area} Sum %'', PCT40.1)

 Percentage of the sum of the values within @var{area}.
 @end table
 
 Percentage of the sum of the values within @var{area}.
 @end table
 


@@ -1369,13 +1395,13 @@ the summary function without the @samp{E}-prefix:
 
 @itemize @bullet
 @item
 
 @itemize @bullet
 @item

-@code{ECOUNT} (``Adjusted Count'')
+@code{ECOUNT} (``Adjusted Count'', F40.0)

 
 @item
 
 @item

-@code{ETOTALN} (``Adjusted Total N'')
+@code{ETOTALN} (``Adjusted Total N'', F40.0)

 
 @item
 
 @item

-@code{EVALIDN} (``Adjusted Valid N'')
+@code{EVALIDN} (``Adjusted Valid N'', F40.0)

 @end itemize
 
 @node CTABLES Unweighted Summary Functions
 @end itemize
 
 @node CTABLES Unweighted Summary Functions


@@ -1387,16 +1413,16 @@ counts:
 
 @itemize @bullet
 @item
 
 @itemize @bullet
 @item

-@code{UCOUNT} (``Unweighted Count'')
+@code{UCOUNT} (``Unweighted Count'', F40.0)

 
 @item
 
 @item

-@code{U@i{area}PCT} or @code{U@i{area}PCT.COUNT} (``Unweighted @i{Area} %'')
+@code{U@i{area}PCT} or @code{U@i{area}PCT.COUNT} (``Unweighted @i{Area} %'', PCT40.1)

 
 @item
 
 @item

-@code{U@i{area}PCT.VALIDN} (``Unweighted @i{Area} Valid N %'')
+@code{U@i{area}PCT.VALIDN} (``Unweighted @i{Area} Valid N %'', PCT40.1)

 
 @item
 
 @item

-@code{U@i{area}PCT.TOTALN} (``Unweighted @i{Area} Total N %'')
+@code{U@i{area}PCT.TOTALN} (``Unweighted @i{Area} Total N %'', PCT40.1)

 
 @item
 @code{UMEAN} (``Unweighted Mean'')
 
 @item
 @code{UMEAN} (``Unweighted Mean'')


@@ -1411,7 +1437,7 @@ counts:
 @code{UMODE} (``Unweight Mode'')
 
 @item
 @code{UMODE} (``Unweight Mode'')
 
 @item

-@code{U@i{area}PCT.SUM} (``Unweighted @i{Area} Sum %'')
+@code{U@i{area}PCT.SUM} (``Unweighted @i{Area} Sum %'', PCT40.1)

 
 @item
 @code{UPTILE} @i{n} (``Unweighted Percentile @i{n}'') 
 
 @item
 @code{UPTILE} @i{n} (``Unweighted Percentile @i{n}'') 


@@ -1426,15 +1452,17 @@ counts:
 @code{USUM} (``Unweighted Sum'')
 
 @item
 @code{USUM} (``Unweighted Sum'')
 
 @item

-@code{UTOTALN} (``Unweighted Total N'')
+@code{UTOTALN} (``Unweighted Total N'', F40.0)

 
 @item
 
 @item

-@code{UVALIDN} (``Unweighted Valid N'')
+@code{UVALIDN} (``Unweighted Valid N'', F40.0)

 
 @item
 
 @item

-@code{UVARIANCE} (``Unweighted Variance'')
+@code{UVARIANCE} (``Unweighted Variance'', F40.0)

 @end itemize
 
 @end itemize
 

+@c TODO missing value treatment
+

 @node CTABLES Statistics Positions and Labels
 @subsection Statistics Positions and Labels
 
 @node CTABLES Statistics Positions and Labels
 @subsection Statistics Positions and Labels
 


@@ -1501,8 +1529,8 @@ CTABLES /TABLE AgeGroup BY qns3a.
 
 @t{ROWLABELS=OPPOSITE} or @t{COLLABELS=OPPOSITE} move row or column
 variable category labels, respectively, to the opposite axis.  The
 
 @t{ROWLABELS=OPPOSITE} or @t{COLLABELS=OPPOSITE} move row or column
 variable category labels, respectively, to the opposite axis.  The

-setting affects only the innermost variable on the given axis.  For
-example:
+setting affects only the innermost variable or variables, which must
+be categorical, on the given axis.  For example:

 
 @example
 CTABLES /TABLE AgeGroup BY qns3a /CLABELS ROWLABELS=OPPOSITE.
 
 @example
 CTABLES /TABLE AgeGroup BY qns3a /CLABELS ROWLABELS=OPPOSITE.


@@ -1516,8 +1544,6 @@ column variable category labels, respectively, to the layer axis.
 Only one axis's labels may be moved, whether to the opposite axis or
 to the layer axis.
 
 Only one axis's labels may be moved, whether to the opposite axis or
 to the layer axis.
 

-@c TODO Moving category labels for stacked variables
-

 @subsubheading Effect on Summary Statistics
 
 @code{CLABELS} primarily affects the appearance of tables, not the
 @subsubheading Effect on Summary Statistics
 
 @code{CLABELS} primarily affects the appearance of tables, not the


@@ -1545,6 +1571,23 @@ CTABLES
 @end example
 @psppoutput {ctables24}
 
 @end example
 @psppoutput {ctables24}
 

+@subsubheading Moving Categories for Stacked Variables
+
+If @code{CLABELS} moves category labels from an axis with stacked
+variables, the variables that are moved must have the same category
+specifications (@pxref{CTABLES Per-Variable Category Options}) and the
+same value labels.
+
+The following shows both moving stacked category variables and
+adapting to the changing definitions of rows and columns:
+
+@example
+CTABLES /TABLE (qn105ba + qn105bb) [COLPCT].
+CTABLES /TABLE (qn105ba + qn105bb) [ROWPCT]
+  /CLABELS ROW=OPPOSITE.
+@end example
+@psppoutput {ctables25}
+

 @node CTABLES Per-Variable Category Options
 @subsection Per-Variable Category Options
 
 @node CTABLES Per-Variable Category Options
 @subsection Per-Variable Category Options
 


@@ -1695,14 +1738,34 @@ or @code{OTHERNM}.
     [@t{CORNER=}@i{string}@dots{}]
 @end display
 
     [@t{CORNER=}@i{string}@dots{}]
 @end display
 

-@c TODO Describe substitution variables
-

 The @code{TITLES} subcommand sets the title, caption, and corner text
 The @code{TITLES} subcommand sets the title, caption, and corner text

-for the table output for the previous @code{TABLE} subcommand.  The
-title appears above the table, the caption below the table, and the
-corner text appears in the table's upper left corner.  By default, the
-title is ``Custom Tables'' and the caption and corner text are empty.
-With some table output styles, the corner text is not displayed.
+for the table output for the previous @code{TABLE} subcommand.  Any
+number of strings may be specified for each kind of text, with each
+string appearing on a separate line in the output.  The title appears
+above the table, the caption below the table, and the corner text
+appears in the table's upper left corner.  By default, the title is
+``Custom Tables'' and the caption and corner text are empty.  With
+some table output styles, the corner text is not displayed.
+
+The strings provided in this subcommand may contain the following
+macro-like keywords that @pspp{} substitutes at the time that it runs
+the command:
+
+@table @code @c (
+@item )DATE
+The current date, e.g.@: MM/DD/YY.  The format is locale-dependent.
+
+@c (
+@item )TIME
+The current time, e.g.@: HH:MM:SS.  The format is locale-dependent.
+
+@c (
+@item )TABLE
+The expression specified on the @code{TABLE} command.  Summary
+and measurement level specifications are omitted, and variable labels are used in place of variable names.
+@end table
+
+@c TODO example

 
 @node CTABLES Table Formatting
 @subsection Table Formatting
 
 @node CTABLES Table Formatting
 @subsection Table Formatting