work on docs
authorBen Pfaff <blp@cs.stanford.edu>
Mon, 28 Feb 2022 04:04:10 +0000 (20:04 -0800)
committerBen Pfaff <blp@cs.stanford.edu>
Sat, 2 Apr 2022 01:48:55 +0000 (18:48 -0700)
doc/statistics.texi

index 18f3d73e8e850b3ee12ef91dea9752add37a98d0..b3aa17d178ebca3db313863a9f2243a9c59ec08a 100644 (file)
@@ -1194,9 +1194,13 @@ The following sections list the available summary functions.
 
 This section lists the summary functions that can be applied to cells
 in @code{CTABLES}.  Many of these functions have an @var{area} in
-their names.  Some @var{area}s correspond to parts of @dfn{subtables},
-whose contents are the cells that pair an innermost row variable and
-an innermost column variable:
+their names.  The supported areas are:
+
+@itemize @bullet
+@item
+Areas that correspond to parts of @dfn{subtables}, whose contents are
+the cells that pair an innermost row variable and an innermost column
+variable:
 
 @table @code
 @item ROW
@@ -1209,7 +1213,8 @@ A column within a subtable.
 All the cells in a subtable
 @end table
 
-Other areas correspond to parts of @dfn{sections}, where stacked
+@item
+Areas that correspond to parts of @dfn{sections}, where stacked
 variables divide each section from another:
 
 @table @code
@@ -1225,16 +1230,14 @@ A row in one layer within a section.
 @item LAYERCOL
 A column in one layer within a section.
 @end table
+@end itemize
 
 The following summary functions may be applied to any variable
 regardless of whether it is categorical or scalar.
 
 @table @asis
 @item @code{COUNT}
-@itemx @code{ECOUNT}
-The sum of weights in a cell (the number of cases, for an unweighted
-dataset).  For @code{ECOUNT}, if the @code{WEIGHT} subcommand
-specified an adjustment weight variable, its sum is used.
+The sum of weights in a cell.
 
 @item @i{area}@code{PCT} or @i{area}@code{PCT.COUNT}
 A percentage within the specified @var{area}.
@@ -1286,21 +1289,47 @@ The standard deviation.
 The sum.
 
 @item @code{TOTALN}
-@itemx @code{ETOTALN}
-The sum of total count weights.  For @code{ETOTALN}, if the
-@code{WEIGHT} subcommand specified an adjustment weight variable, its
-sum is used.
+The sum of total count weights.
 
 @item @code{VALIDN}
-@itemx @code{EVALIDN}
-The sum of valid count weights.  For @code{ETOTALN}, if the
-@code{WEIGHT} subcommand specified an adjustment weight variable, its
-sum is used.
+The sum of valid count weights.
 
 @item @code{VARIANCE}
 The variance.
 @end table
 
+If the @code{WEIGHT} subcommand specified an adjustment weight
+variable, then the following summary functions use its value instead
+of the dictionary weight variable.  Otherwise, they are equivalent to
+the summary function without the @samp{E}-prefix:
+
+@itemize @bullet
+@item @code{ECOUNT}
+@item @code{ETOTALN}
+@item @code{EVALIDN}
+@end itemize
+
+The following summary functions with a @samp{U}-prefix are equivalent
+to those without a prefix, except that they use unweighted counts:
+
+@itemize @bullet
+@item @code{UCOUNT}
+@item @code{U}@i{area}@code{PCT} or @code{U}@i{area}@code{PCT.COUNT}
+@item @code{U}@i{area}@code{PCT.VALIDN}
+@item @code{U}@i{area}@code{PCT.TOTALN}
+@item @code{UMEAN}
+@item @code{UMEDIAN}
+@item @code{UMISSING}
+@item @code{UMODE}
+@item @code{U}@i{area}@code{PCT.SUM}
+@item @code{UPTILE} @i{n}
+@item @code{USEMEAN}
+@item @code{USTDDEV}
+@item @code{USUM}
+@item @code{UTOTALN}
+@item @code{UVALIDN}
+@item @code{UVARIANCE}
+@end itemize
 
 @node FACTOR, GLM, CTABLES, Statistics
 @section FACTOR