INSET Statement |
An INSET statement places a box or table of summary statistics, called an inset, directly in a graph created with a CDFPLOT, HISTOGRAM, PPPLOT, PROBPLOT, or QQPLOT statement. The INSET statement must follow the plot statement that creates the plot that you want to augment. The inset appears in all the graphs that the preceding plot statement produces.
You can use multiple INSET statements after a plot statement to add more than one inset to a plot. See Example 4.17.
In an INSET statement, you specify one or more keywords that identify the information to display in the inset. The information is displayed in the order that you request the keywords. Keywords can be any of the following:
statistical keywords
primary keywords
secondary keywords
The available statistical keywords are listed in Table 4.35 through Table 4.41.
Keyword |
Description |
---|---|
CSS |
corrected sum of squares |
CV |
coefficient of variation |
KURTOSIS | KURT |
kurtosis |
MAX |
largest value |
MEAN |
sample mean |
MIN |
smallest value |
MODE |
most frequent value |
N |
sample size |
NEXCL |
number of observations excluded by MAXNBIN= or MAXSIGMAS= option |
NMISS |
number of missing values |
NOBS |
number of observations |
RANGE |
range |
SKEWNESS | SKEW |
skewness |
STD | STDDEV |
standard deviation |
STDMEAN | STDERR |
standard error of the mean |
SUM |
sum of the observations |
SUMWGT |
sum of the weights |
USS |
uncorrected sum of squares |
VAR |
variance |
Keyword |
Description |
---|---|
P1 |
1st percentile |
P5 |
5th percentile |
P10 |
10th percentile |
Q1 |
|
P25 |
lower quartile (25th percentile) |
MEDIAN |
|
Q2 |
|
P50 |
median (50th percentile) |
Q3 |
|
P75 |
upper quartile (75th percentile) |
P90 |
90th percentile |
P95 |
95th percentile |
P99 |
99th percentile |
QRANGE |
interquartile range (Q3 - Q1) |
Table 4.37 lists keywords for distribution-free confidence limits for percentiles requested with the CIPCTLDF option.
Keyword |
Description |
---|---|
P1_LCL_DF |
1st percentile lower confidence limit |
P1_UCL_DF |
1st percentile upper confidence limit |
P5_LCL_DF |
5th percentile lower confidence limit |
P5_UCL_DF |
5th percentile upper confidence limit |
P10_LCL_DF |
10th percentile lower confidence limit |
P10_UCL_DF |
10th percentile upper confidence limit |
Q1_LCL_DF |
|
P25_LCL_DF |
lower quartile (25th percentile) lower confidence limit |
Q1_UCL_DF |
|
P25_UCL_DF |
lower quartile (25th percentile) upper confidence limit |
MEDIAN_LCL_DF |
|
Q2_LCL_DF |
|
P50_LCL_DF |
median (50th percentile) lower confidence limit |
MEDIAN_UCL_DF |
|
Q2_UCL_DF |
|
P50_UCL_DF |
median (50th percentile) upper confidence limit |
Q3_LCL_DF |
|
P75_LCL_DF |
upper quartile (75th percentile) lower confidence limit |
Q3_UCL_DF |
|
P75_UCL_DF |
upper quartile (75th percentile) upper confidence limit |
P90_LCL_DF |
90th percentile lower confidence limit |
P90_UCL_DF |
90th percentile upper confidence limit |
P95_LCL_DF |
95th percentile lower confidence limit |
P95_UCL_DF |
95th percentile upper confidence limit |
P99_LCL_DF |
99th percentile lower confidence limit |
P99_UCL_DF |
99th percentile upper confidence limit |
Table 4.38 lists keywords for percentile confidence limits computed assuming normality requested with the CIPCTLNORMAL option.
Keyword |
Description |
---|---|
P1_LCL |
1st percentile lower confidence limit |
P1_UCL |
1st percentile upper confidence limit |
P5_LCL |
5th percentile lower confidence limit |
P5_UCL |
5th percentile upper confidence limit |
P10_LCL |
10th percentile lower confidence limit |
P10_UCL |
10th percentile upper confidence limit |
Q1_LCL |
|
P25_LCL |
lower quartile (25th percentile) lower confidence limit |
Q1_UCL |
|
P25_UCL |
lower quartile (25th percentile) upper confidence limit |
MEDIAN_LCL |
|
Q2_LCL |
|
P50_LCL |
median (50th percentile) lower confidence limit |
MEDIAN_UCL |
|
Q2_UCL |
|
P50_UCL |
median (50th percentile) upper confidence limit |
Q3_LCL |
|
P75_LCL |
upper quartile (75th percentile) lower confidence limit |
Q3_UCL |
|
P75_UCL |
upper quartile (75th percentile) upper confidence limit |
P90_LCL |
90th percentile lower confidence limit |
P90_UCL |
90th percentile upper confidence limit |
P95_LCL |
95th percentile lower confidence limit |
P95_UCL |
95th percentile upper confidence limit |
P99_LCL |
99th percentile lower confidence limit |
P99_UCL |
99th percentile upper confidence limit |
Keyword |
Description |
---|---|
GINI |
Gini’s mean difference |
MAD |
median absolute difference about the median |
QN |
, alternative to MAD |
SN |
, alternative to MAD |
STD_GINI |
Gini’s standard deviation |
STD_MAD |
MAD standard deviation |
STD_QN |
standard deviation |
STD_QRANGE |
interquartile range standard deviation |
STD_SN |
standard deviation |
Keyword |
Description |
---|---|
MSIGN |
sign statistic |
NORMALTEST |
test statistic for normality |
PNORMAL |
probability value for the test of normality |
SIGNRANK |
signed rank statistic |
PROBM |
probability of greater absolute value for the sign statistic |
PROBN |
probability value for the test of normality |
PROBS |
probability value for the signed rank test |
PROBT |
probability value for the Student’s test |
T |
statistics for Student’s test |
Keyword |
Description |
---|---|
DATA= |
(label, value) pairs from input data set |
To create a completely customized inset, use a DATA= data set.
requests that PROC UNIVARIATE display customized statistics from a SAS data set in the inset table. The data set must contain two variables:
a character variable whose values provide labels for inset entries
a variable that is either character or numeric and whose values provide values for inset entries
The label and value from each observation in the data set occupy one line in the inset. The position of the DATA= keyword in the keyword list determines the position of its lines in the inset.
A primary keyword enables you to specify secondary keywords in parentheses immediately after the primary keyword. The primary keywords are listed in Table 4.42 and Table 4.43. If you specify a primary keyword but omit a secondary keyword, the inset displays a colored line and the distribution name as a key for the density curve.
By default, PROC UNIVARIATE identifies inset statistics with appropriate labels and prints numeric values with appropriate formats. To customize the label, specify the keyword followed by an equal sign (=) and the desired label in quotes. To customize the format, specify a numeric format in parentheses after the keyword. Labels can have up to 24 characters. If you specify both a label and a format for a statistic, the label must appear before the format. For example,
inset n='Sample Size' std='Std Dev' (5.2);
requests customized labels for two statistics and displays the standard deviation with a field width of 5 and two decimal places.
Keyword |
Distribution |
Plot Statement Availability |
---|---|---|
BETA |
beta |
all plot statements |
EXPONENTIAL |
exponential |
all plot statements |
GAMMA |
gamma |
all plot statements |
GUMBEL |
Gumbel |
all plot statements |
IGAUSS |
inverse Gaussian |
CDFPLOT, HISTOGRAM, PPPLOT |
LOGNORMAL |
lognormal |
all plot statements |
NORMAL |
normal |
all plot statements |
PARETO |
Pareto |
all plot statements |
POWER |
power function |
all plot statements |
RAYLEIGH |
Rayleigh |
all plot statements |
SB |
Johnson |
HISTOGRAM |
SU |
Johnson |
HISTOGRAM |
WEIBULL |
Weibull(3-parameter) |
all plot statements |
WEIBULL2 |
Weibull(2-parameter) |
PROBPLOT, QQPLOT |
Keyword |
Description |
---|---|
KERNEL |
displays statistics for all kernel estimates |
KERNEL |
displays statistics for only the th kernel density estimate |
|
Table 4.44 through Table 4.58 list the secondary keywords available with primary keywords in Table 4.42 and Table 4.43.
Secondary Keyword |
Alias |
Description |
---|---|---|
ALPHA |
SHAPE1 |
first shape parameter |
BETA |
SHAPE2 |
second shape parameter |
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
lower threshold parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
threshold parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
ALPHA |
SHAPE |
shape parameter |
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
threshold parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
MEAN |
mean of the fitted distribution |
|
MU |
location parameter |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
Secondary Keyword |
Alias |
Description |
---|---|---|
LAMBDA |
shape parameter |
|
MEAN |
mean of the fitted distribution |
|
MU |
mean parameter |
|
STD |
standard deviation of the fitted distribution |
Secondary Keyword |
Alias |
Description |
---|---|---|
MEAN |
mean of the fitted distribution |
|
SIGMA |
SHAPE |
shape parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
threshold parameter |
ZETA |
SCALE |
scale parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
MU |
MEAN |
mean parameter |
SIGMA |
STD |
scale parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
ALPHA |
shape parameter |
|
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
threshold parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
ALPHA |
shape parameter |
|
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
threshold parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
threshold parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
DELTA |
SHAPE1 |
first shape parameter |
GAMMA |
SHAPE2 |
second shape parameter |
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
lower threshold parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
C |
SHAPE |
shape parameter |
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
threshold parameter |
Secondary Keyword |
Alias |
Description |
---|---|---|
C |
SHAPE |
shape parameter |
MEAN |
mean of the fitted distribution |
|
SIGMA |
SCALE |
scale parameter |
STD |
standard deviation of the fitted distribution |
|
THETA |
THRESHOLD |
known lower threshold |
Secondary Keyword |
Description |
---|---|
AMISE |
approximate mean integrated square error (MISE) for the kernel density |
BANDWIDTH |
bandwidth for the density estimate |
BWIDTH |
alias for BANDWIDTH |
C |
standardized bandwidth for the density estimate: |
where sample size, bandwidth, and |
|
interquartile range |
|
TYPE |
kernel type: normal, quadratic, or triangular |
Secondary Keyword |
Description |
---|---|
AD |
Anderson-Darling EDF test statistic |
ADPVAL |
Anderson-Darling EDF test -value |
CVM |
Cramér-von Mises EDF test statistic |
CVMPVAL |
Cramér-von Mises EDF test -value |
KSD |
Kolmogorov-Smirnov EDF test statistic |
KSDPVAL |
Kolmogorov-Smirnov EDF test -value |
The inset statistics listed in Table 4.42 through Table 4.58 are not available unless you request a plot statement and options that calculate these statistics. For example, consider the following statements:
proc univariate data=score; histogram final / normal; inset mean std normal(ad adpval); run;
The MEAN and STD keywords display the sample mean and standard deviation of final. The NORMAL keyword with the secondary keywords AD and ADPVAL display the Anderson-Darling goodness-of-fit test statistic and -value. The statistics that are specified with the NORMAL keyword are available only because the NORMAL option is requested in the HISTOGRAM statement.
The KERNEL or KERNELkeyword is available only if you request a kernel density estimate in a HISTOGRAM statement. The WEIBULL2 keyword is available only if you request a two-parameter Weibull distribution in the PROBPLOT or QQPLOT statement.
If you specify multiple kernel density estimates, you can request inset statistics for all the estimates with the KERNEL keyword. Alternatively, you can display inset statistics for individual curves with the KERNELkeyword, where is the curve number between 1 and 5.
Table 4.59 lists INSET statement options, which are specified after the slash (/) in the INSET statement. For complete descriptions, see the section Dictionary of Options.
Option |
Description |
---|---|
specifies color of inset background |
|
specifies color of header background |
|
specifies color of frame |
|
specifies color of header text |
|
specifies color of drop shadow |
|
specifies color of inset text |
|
specifies data units for POSITION= coordinates |
|
specifies font of text |
|
specifies format of values in inset |
|
specifies gutter width for inset in top or bottom margin |
|
specifies header text |
|
specifies height of inset text |
|
specifies number of columns for inset in top or bottom margin |
|
suppresses frame around inset |
|
specifies position of inset |
|
specifies reference point of inset positioned with POSITION= coordinates |
The following entries provide detailed descriptions of options for the INSET statement. Options marked with † are applicable only when traditional graphics are produced.
specifies the color of the background for traditional graphics. If you omit the CFILLH= option the header background is included. By default, the background is empty, which causes items that overlap the inset (such as curves or histogram bars) to show through the inset.
If you specify a value for CFILL= option, then overlapping items no longer show through the inset. Use CFILL=BLANK to leave the background uncolored and to prevent items from showing through the inset.
specifies the color of the header background for traditional graphics. The default value is the CFILL= color.
specifies the color of the frame for traditional graphics. The default value is the same color as the axis of the plot.
specifies the color of the header text for traditional graphics. The default value is the CTEXT= color.
specifies the color of the drop shadow for traditional graphics. By default, if a CSHADOW= option is not specified, a drop shadow is not displayed.
specifies the color of the text for traditional graphics. The default value is the same color as the other text on the plot.
specifies that data coordinates are to be used in positioning the inset with the POSITION= option. The DATA option is available only when you specify POSITION=(x,y). You must place DATA immediately after the coordinates (x,y). Note: Positioning insets with coordinates is not supported for ODS Graphics output.
specifies the font of the text for traditional graphics. By default, if you locate the inset in the interior of the plot, then the font is SIMPLEX. If you locate the inset in the exterior of the plot, then the font is the same as the other text on the plot.
specifies a format for all the values in the inset. If you specify a format for a particular statistic, then that format overrides the one specified with the FORMAT= option. For more information about SAS formats, see SAS Formats and Informats: Reference.
specifies the gutter width in percent screen units for an inset located in the top or bottom margin. The gutter is the space between columns of (label, value) pairs in an inset. The default value is four. Note: The GUTTER= option applies only when ODS Graphics is enabled.
specifies the header text. The string cannot exceed 40 characters. By default, no header line appears in the inset. If all the keywords that you list in the INSET statement are secondary keywords that correspond to a fitted curve on a histogram, PROC UNIVARIATE displays a default header that indicates the distribution and identifies the curve.
specifies the height of the text for traditional graphics.
specifies the number of columns of (label, value) pairs displayed in an inset located in the top or bottom margin. The default value is three. Note: The NCOLS= option applies only when ODS Graphics is enabled.
suppresses the frame drawn around the text.
determines the position of the inset. The position is a compass point keyword, a margin keyword, or a pair of coordinates (x,y). You can specify coordinates in axis percent units or axis data units. The default value is NW, which positions the inset in the upper left (northwest) corner of the display. See the section Positioning Insets.
Note: Positioning insets with coordinates is not supported for ODS Graphics output.
specifies the reference point for an inset that PROC UNIVARIATE positions by a pair of coordinates with the POSITION= option. The REFPOINT= option specifies which corner of the inset frame that you want to position at coordinates (x,y). The keywords are BL, BR, TL, and TR, which correspond to bottom left, bottom right, top left, and top right. The default value is BL. You must use REFPOINT= with POSITION=(x,y) coordinates. The option does not apply to ODS Graphics output.