Chapter Contents
Chapter Contents
Previous
Previous
Next
Next
The PROBIT Procedure

CDFPLOT Statement

CDFPLOT <var = variable> <options >;
The CDFPLOT statement plots the predicted cumulative distribution function (CDF) of the multinomial response variable as a function of a single continuous independent variable (dose variable). You can only use this statement after a multinomial model statement.

VAR= (variable)
specifies a single continuous variable (dose variable) in the independent variable list of the MODEL statement. If a VAR= variable is not specified, the first single continuous variable in the independent variable list of the MODEL statement is used. If such a variable does not exist in the independent variable list of the MODEL statement, an error is reported.

The predicted cumulative distribution function is defined as
{\hat F}_{j}(x)=C + (1-C)F({\hat a}_j + x^{'} \hat b)
where j = 1, ... ,k are the indexes of the k levels of the multinomial response variable, F is the CDF of the distribution used to model the cumulative probabilities, \hat b is the vector of estimated parameters, x is the covariate vector, {\hat a}_j are estimated ordinal intercepts with {\hat a}_1=0, and C is the threshold parameter, either known or estimated from the model. Let x1 be the covariate corresponding to the dose variable and x-1 be the vector of the rest of the covariates. Let the corresponding estimated parameters be {\hat b}_1 and {\hat b}_{-1}. Then
{\hat F}_{j}(x)=C + (1-C)F({\hat a}_j + x_1 {\hat b}_1 + x^{'}_{-1} {{\hat b}}_{-1})

To plot {\hat F}_{j} as a function of x1, x-1 must be specified. You can use the XDATA= option to provide the values of x-1 (see the XDATA= option in the PROC PROBIT statement for details), or use the default values that follow the rules:

options
specify the levels of the multinomial response variable for which the cdf curves are requested, and add features to the plot. There are k-1 curves for a k-level multinomial response variable (for the highest level, it is the constant line 1). You can specify any of them to be plotted by the LEVEL= option in the CDFPLOT statement. See the LEVEL= option for how to specify the levels.

An attached box on the right side of the plot is used to label these curves with the names of their levels. You can specify the color of this box using the CLABBOX= option.

You can use options in the CDFPLOT statement to

Summary of Options

The following tables list all options by function. The "Dictionary of Options" describes each option in detail.



Table 12.1: Options for CDFPLOT
LEVEL=character-list specifies the names of the levels for which the cdf curves are requested
NOTHRESHsuppresses the threshold line
THRESHLABPOS=valuespecifies the position for the label of the threshold line


Table 12.2: Color Options
CAXIS=colorspecifies color for axis
CFIT=colorspecifies color for fitted curves
CFRAME=colorspecifies color for frame
CGRID=colorspecifies color for grid lines
CHREF=colorspecifies color for HREF= lines
CLABBOX=colorspecifies color for label box
CTEXT=colorspecifies color for text
CVREF=colorspecifies color for VREF= lines


Table 12.3: Options to Enhance Plots Produced on Graphics Devices
ANNOTATE= SAS-data-setspecifies an ANNOTATE data set
INBORDERrequests a border around plot
LFIT=linetypespecifies line style for fitted curves
LGRID=linetypespecifies line style for grid lines
NOFRAMEsuppresses the frame around plotting areas
NOGRIDsuppresses grid lines
NOFITsuppresses cdf curves
NOHLABELsuppresses horizontal labels
NOHTICKsuppresses horizontal ticks
NOVTICKsuppresses vertical ticks
TURNVLABELSvertically string out characters in vertical labels
WFIT=nspecifies thickness for fitted curves
WGRID=nspecifies thickness for grids
WREFL=nspecifies thickness for reference lines


Table 12.4: Axis Options
HAXIS=value1 to value2 <by value3>specifies tick mark values for horizontal axis
HOFFSET=valuespecifies offset for horizontal axis
HLOWER=valuespecifies lower limit on horizontal axis scale
HUPPER=valuespecifies upper limit on horizontal axis scale
NHTICK=nspecifies number of ticks for horizontal axis
NVTICK=nspecifies number of ticks for vertical axis
VAXIS=value1 to value2 <by value3>specifies tick mark values for vertical axis
VAXISLABEL='label'specifies label for vertical axis
VOFFSET=valuespecifies offset for vertical axis
VLOWER=valuespecifies lower limit on vertical axis scale
VUPPER=valuespecifies upper limit on vertical axis scale
WAXIS=nspecifies thickness for axis


Table 12.5: Graphics Catalog Options
DESCRIPTION='string'specifies description for graphics catalog member
NAME='string'specifies name for plot in graphics catalog


Table 12.6: Options for Text Enhancement
FONT=fontspecifies software font for text
HEIGHT=valuespecifies height of text used outside framed areas
INFONT=fontspecifies software font for text inside framed areas
INHEIGHT=valuespecifies height of text inside framed areas


Table 12.7: Options for Reference Lines
HREF< (INTERSECT)> =value-listrequests horizontal reference line
HREFLABELS= ('label1',...,'labeln')specifies labels for HREF= lines
HREFLABPOS=nspecifies vertical position of labels for HREF= lines
LHREF=linetypespecifies line style for HREF= lines
LVREF=linetypespecifies line style for VREF= lines
VREF<(INTERSECT)> =value-listrequests vertical reference line
VREFLABELS= ('label1',...,'labeln')specifies labels for VREF= lines
VREFLABPOS=nspecifies horizontal position of labels for VREF= lines


Dictionary of Options

The following entries provide detailed descriptions of the options in the CDFPLOT statement.

ANNOTATE=SAS-data-set
ANNO=SAS-data-set
specifies an ANNOTATE data set, as described in SAS/GRAPH Software: Reference, that enables you to add features to the cdf plot. The ANNOTATE= data set you specify in the CDFPLOT statement is used for all plots created by the statement.

CAXIS=color
CAXES=color
specifies the color used for the axes and tick marks. This option overrides any COLOR= specifications in an AXIS statement. The default is the first color in the device color list.

CFIT=color
specifies the color for the fitted cdf curves. The default is the first color in the device color list.

CFRAME=color
CFR=color
specifies the color for the area enclosed by the axes and frame. This area is not shaded by default.

CGRID=color
specifies the color for grid lines. The default is the first color in the device color list.

CLABBOX=color
specifies the color for the area enclosed by the label box for cdf curves. This area is not shaded by default.

CHREF=color
CH=color
specifies the color for lines requested by the HREF= option. The default is the first color in the device color list.

CTEXT=color
specifies the color for tick mark values and axis labels. The default is the color specified for the CTEXT= option in the most recent GOPTIONS statement.

CVREF=color
CV=color
specifies the color for lines requested by the VREF= option. The default is the first color in the device color list.

DESCRIPTION='string'
DES='string'
specifies a description, up to 40 characters, that appears in the PROC GREPLAY master menu. The default is the variable name.

FONT=font
specifies a software font for reference line and axis labels. You can also specify fonts for axis labels in an AXIS statement. The FONT= font takes precedence over the FTEXT= font specified in the most recent GOPTIONS statement. Hardware characters are used by default.

HAXIS=value1 to value2<by value3>
specifies tick mark values for the horizontal axis. value1, value2, and value3 must be numeric, and value1 must be less than value2. The lower tick mark is value1. Tick marks are drawn at increments of value3. The last tick mark is the greatest value that does not exceed value2. If value3 is omitted, a value of 1 is used.

Examples of HAXIS= lists are:
   haxis = 0 to 10
   haxis = 2 to 10 by 2
   haxis = 0 to 200 by 10


HEIGHT=value
specifies the height of text used outside framed areas. The default value is 3.846 (in percentage).

HLOWER=value
specifies the lower limit on the horizontal axis scale. The HLOWER= option specifies value as the lower horizontal axis tick mark. The tick mark interval and the upper axis limit are determined automatically. This option has no effect if the HAXIS= option is used.

HOFFSET=value
specifies offset for horizontal axis. The default value is 1.

HUPPER=value
specifies value as the upper horizontal axis tick mark. The tick mark interval and the lower axis limit are determined automatically. This option has no effect if the HAXIS= option is used.

HREF <(INTERSECT)> =value-list
requests reference lines perpendicular to the horizontal axis. If (INTERSECT) is specified, a second reference line perpendicular to the vertical axis is drawn that intersects the fit line at the same point as the horizontal axis reference line. If a horizontal axis reference line label is specified, the intersecting vertical axis reference line is labeled with the vertical axis value. See also the CHREF=, HREFLABELS=, and LHREF= options.

HREFLABELS='label1',...,'labeln'
HREFLABEL='label1',...,'labeln'
HREFLAB='label1',...,'labeln'
specifies labels for the lines requested by the HREF= option. The number of labels must equal the number of lines. Enclose each label in quotes. Labels can be up to 16 characters.

HREFLABPOS=n
specifies the vertical position of labels for HREF= lines. The following table shows valid values for n and the corresponding label placements.

n label placement
1top
2staggered from top
3bottom
4staggered from bottom
5alternating from top
6alternating from bottom


INBORDER
requests a border around cdf plots.

LEVEL= (character-list)
ORDINAL= (character-list)
specifies the names of the levels for which cdf curves are requested. Names should be quoted and separated by space. If there is no correct name provided, no cdf curve is plotted.

LFIT=linetype
specifies a line style for fitted curves. By default, fitted curves are drawn by connecting solid lines (linetype = 1).

LGRID=linetype
specifies a line style for all grid lines. linetype is between 1 and 46. The default is 35.

LHREF=linetype
LH=linetype
specifies the line type for lines requested by the HREF= option. The default is 2, which produces a dashed line.

LVREF=linetype
LV=linetype
specifies the line type for lines requested by the VREF= option. The default is 2, which produces a dashed line.

NAME='string'
specifies a name for the plot, up to eight characters, that appears in the PROC GREPLAY master menu. The default is 'PROBIT'.

NOFIT
suppresses the fitted cdf curves.

NOFRAME
suppresses the frame around plotting areas.

NOGRID
suppresses grid lines.

NOHLABEL
suppresses horizontal labels.

NOHTICK
suppresses horizontal tick marks.

NOTHRESH
suppresses the threshold line.

NOVLABEL
suppresses vertical labels.

NOVTICK
suppresses vertical tick marks.

THRESHLABPOS=n
specifies the horizontal position of labels for the threshold line. The following table shows valid values for n and the corresponding label placements.

n label placement
1left
2right


VAXIS=value1 to value2<by value3>
specifies tick mark values for the vertical axis. value1, value2, and value3 must be numeric, and value1 must be less than value2. The lower tick mark is value1. Tick marks are drawn at increments of value3. The last tick mark is the greatest value that does not exceed value2. This method of specification of tick marks is not valid for logarithmic axes. If value3 is omitted, a value of 1 is used.

Examples of VAXIS= lists are:
   vaxis = 0 to 10
   vaxis = 0 to 2 by .1


VAXISLABEL='string'
specifies a label for the vertical axis.

VLOWER=value
specifies the lower limit on the vertical axis scale. The VLOWER= option specifies value as the lower vertical axis tick mark. The tick mark interval and the upper axis limit are determined automatically. This option has no effect if the VAXIS= option is used.

VREF=value-list
requests reference lines perpendicular to the vertical axis. If (INTERSECT) is specified, a second reference line perpendicular to the horizontal axis is drawn that intersects the fit line at the same point as the vertical axis reference line. If a vertical axis reference line label is specified, the intersecting horizontal axis reference line is labeled with the horizontal axis value. See also the CVREF=, LVREF=, and VREFLABELS= options.

VREFLABELS='label1',...,'labeln'
VREFLABEL='label1',...,'labeln'
VREFLAB='label1',...,'labeln'
specifies labels for the lines requested by the VREF= option. The number of labels must equal the number of lines. Enclose each label in quotes. Labels can be up to 16 characters.

VREFLABPOS=n
specifies the horizontal position of labels for VREF= lines. The following table shows valid values for n and the corresponding label placements.

n label placement
1left
2right


VUPPER=value
specifies the upper limit on the vertical axis scale. The VUPPER= option specifies value as the upper vertical axis tick mark. The tick mark interval and the lower axis limit are determined automatically. This option has no effect if the VAXIS= option is used.

WAXIS=n
specifies line thickness for axes and frame. The default value is 1.

WFIT=n
specifies line thickness for fitted curves. The default value is 1.

WGRID=n
specifies line thickness for grids. The default value is 1.

WREFL=n
specifies line thickness for reference lines. The default value is 1.

Chapter Contents
Chapter Contents
Previous
Previous
Next
Next
Top
Top

Copyright © 2001 by SAS Institute Inc., Cary, NC, USA. All rights reserved.