From 516498aeacfb469b79a2fa411553fbc11766a7fc Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Tue, 16 Aug 2022 07:29:34 -0700 Subject: [PATCH] docs --- doc/statistics.texi | 45 ++++++++++++++++++++++++--------------------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/doc/statistics.texi b/doc/statistics.texi index 1b0a294218..44db27aad1 100644 --- a/doc/statistics.texi +++ b/doc/statistics.texi @@ -1155,8 +1155,6 @@ sets. @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 @@ -1188,6 +1186,8 @@ CTABLES /TABLE=AgeGroup [COLPCT 'Gender %' PCT5.0, @end example @psppoutput {ctables11} +@c TODO special CTABLES formats + Parentheses provide a shorthand to apply summary specifications to multiple variables. For example, both of these commands: @@ -1201,7 +1201,10 @@ produce the same output shown below: @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:: @@ -1218,7 +1221,7 @@ individual cell in @code{CTABLES}. Only one such summary function, @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 @@ -1268,7 +1271,7 @@ The standard deviation. @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. @@ -1280,7 +1283,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. -@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 @@ -1341,13 +1344,13 @@ each @var{area} described above, for both categorical and scale 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}. -@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}. -@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 @@ -1355,7 +1358,7 @@ Scale variables and totals and subtotals for categorical variables may 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 @@ -1369,13 +1372,13 @@ the summary function without the @samp{E}-prefix: @itemize @bullet @item -@code{ECOUNT} (``Adjusted Count'') +@code{ECOUNT} (``Adjusted Count'', F40.0) @item -@code{ETOTALN} (``Adjusted Total N'') +@code{ETOTALN} (``Adjusted Total N'', F40.0) @item -@code{EVALIDN} (``Adjusted Valid N'') +@code{EVALIDN} (``Adjusted Valid N'', F40.0) @end itemize @node CTABLES Unweighted Summary Functions @@ -1387,16 +1390,16 @@ counts: @itemize @bullet @item -@code{UCOUNT} (``Unweighted Count'') +@code{UCOUNT} (``Unweighted Count'', F40.0) @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 -@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 -@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'') @@ -1411,7 +1414,7 @@ counts: @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}'') @@ -1426,13 +1429,13 @@ counts: @code{USUM} (``Unweighted Sum'') @item -@code{UTOTALN} (``Unweighted Total N'') +@code{UTOTALN} (``Unweighted Total N'', F40.0) @item -@code{UVALIDN} (``Unweighted Valid N'') +@code{UVALIDN} (``Unweighted Valid N'', F40.0) @item -@code{UVARIANCE} (``Unweighted Variance'') +@code{UVARIANCE} (``Unweighted Variance'', F40.0) @end itemize @node CTABLES Statistics Positions and Labels -- 2.30.2