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

index b3aa17d178ebca3db313863a9f2243a9c59ec08a..8445b51b099e077155ccac80cc90902fa6725098 100644 (file)
@@ -1232,69 +1232,71 @@ 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.
+The following table lists summary functions that may be applied to any
+variable regardless of whether it is categorical or scalar, along with
+their default labels:
 
 @table @asis
-@item @code{COUNT}
+@item @code{COUNT} (``Count'')
 The sum of weights in a cell.
 
-@item @i{area}@code{PCT} or @i{area}@code{PCT.COUNT}
+@item @i{area}@code{PCT} or @i{area}@code{PCT.COUNT} (``@i{Area} %'')
 A percentage within the specified @var{area}.
 
-@item @i{area}@code{PCT.VALIDN}
+@item @i{area}@code{PCT.VALIDN} (``@i{Area} Valid N %'')
 A percentage of valid values within the specified @var{area}.
 
-@item @i{area}@code{PCT.TOTALN}
+@item @i{area}@code{PCT.TOTALN} (``@i{Area} Total N %'')
 A percentage of total values within the specified @var{area}.
 @end table
 
-The following summary functions apply only to scale variables:
+The following table lists summary functions that apply only to scale
+variables:
 
 @table @asis
-@item @code{MAXIMUM}
+@item @code{MAXIMUM} (``Maximum'')
 The largest value.
 
-@item @code{MEAN}
+@item @code{MEAN} (``Mean'')
 The mean.
 
-@item @code{MEDIAN}
+@item @code{MEDIAN} (``Median'')
 The median value.
 
-@item @code{MINIMUM}
+@item @code{MINIMUM} (``Minimum'')
 The smallest value.
 
-@item @code{MISSING}
+@item @code{MISSING} (``Missing'')
 Sum of weights of user- and system-missing values.
 
-@item @code{MODE}
+@item @code{MODE} (``Mode'')
 The highest-frequency value.  Ties are broken by taking the smallest mode.
 
-@item @i{area}@code{PCT.SUM}
+@item @i{area}@code{PCT.SUM} (``@i{Area} Sum %'')
 Percentage of the sum of the values across @var{area}.
 
-@item @code{PTILE} @i{n}
+@item @code{PTILE} @i{n} (``Percentile @i{n}'')
 The @var{n}th percentile, where @math{0 @leq{} @var{n} @leq{} 100}.
 
-@item @code{RANGE}
+@item @code{RANGE} (``Range'')
 The maximum minus the minimum.
 
-@item @code{SEMEAN}
+@item @code{SEMEAN} (``Std Error of Mean'')
 The standard error of the mean.
 
-@item @code{STDDEV}
+@item @code{STDDEV} (``Std Deviation'')
 The standard deviation.
 
-@item @code{SUM}
+@item @code{SUM} (``Sum'')
 The sum.
 
-@item @code{TOTALN}
+@item @code{TOTALN} (``Total N'')
 The sum of total count weights.
 
-@item @code{VALIDN}
+@item @code{VALIDN} (``Valid N'')
 The sum of valid count weights.
 
-@item @code{VARIANCE}
+@item @code{VARIANCE} (``Variance'')
 The variance.
 @end table
 
@@ -1304,31 +1306,31 @@ 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}
+@item @code{ECOUNT} (``Adjusted Count'')
+@item @code{ETOTALN} (``Adjusted Total N'')
+@item @code{EVALIDN} (``Adjusted Valid N'')
 @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}
+@item @code{UCOUNT} (``Unweighted Count'')
+@item @code{U}@i{area}@code{PCT} or @code{U}@i{area}@code{PCT.COUNT} (``Unweighted @i{Area} %'')
+@item @code{U}@i{area}@code{PCT.VALIDN} (``Unweighted @i{Area} Valid N %'')
+@item @code{U}@i{area}@code{PCT.TOTALN} (``Unweighted @i{Area} Total N %'')
+@item @code{UMEAN} (``Unweighted Mean'')
+@item @code{UMEDIAN} (``Unweighted Median'')
+@item @code{UMISSING} (``Unweighted Missing'')
+@item @code{UMODE} (``Unweight Mode'')
+@item @code{U}@i{area}@code{PCT.SUM} (``Unweighted @i{Area} Sum %'')
+@item @code{UPTILE} @i{n} (``Unweighted Percentile @i{n}'') 
+@item @code{USEMEAN} (``Unweighted Std Error of Mean'')
+@item @code{USTDDEV} (``Unweighted Std Deviation'')
+@item @code{USUM} (``Unweighted Sum'')
+@item @code{UTOTALN} (``Unweighted Total N'')
+@item @code{UVALIDN} (``Unweighted Valid N'')
+@item @code{UVARIANCE} (``Unweighted Variance'')
 @end itemize
 
 @node FACTOR, GLM, CTABLES, Statistics