Macroplot plotting is controlled by the macros in the text area provided.
Each macro must occupy its own line. If the first character of a macro is not A-Z, the line will be considered a comment and ignored
The first macro, which is obligatory, initializes the plot. The macro is
Bitmap Initialize width(in pixels), height(in pixels), red(0-255) blue(0-255), green(0-255) transparency(0-255)
Example : Bitmap Initialize 700 500 255 255 255 255 which provides a landscape area 700 pixels wide, 500 pixel high, with white background
The following are default settings when the bitmap is initiated.
Lines are black (0 0 0 255) and 3 pixels in width
Fill color for bars and dots are black (0 0 0 255), and the fill type is set to fill only (1) (see Fill Type)
Dots (circl and square) are set to 5 pixels radius (diameter=11 pixels)
Fonts are set as follows
Font face is set to sans-serif. Serif, sans-serif, and monospace are available to all browsers, user can use any font available to his/her browser
Font size is set to 16 pixels high
Font color, both line and fill are set to black (0 0 0 255), and fill type to 1 (fill only) (see Font Type)
Macros for plotting on the bitmap begin with the keyword Bitmap, and the coordinates are x=number of pixels from the left border and y=number of pixels from the top border
A central plotting area is also defined
By default, at initialization, as 15% from the left and bottom, 5% from right and top
defined by user as Plot Pixels left top right bottom, these being number of pixels from the left and top border
e.g. Plot Pixels 105 25 665 425 would be the same as the default setting for a bitmap of 700 pixels wide and 500 pixels high
The values of the data used in plotting in this central area can be defined as follows
Plot Values left top right bottom, these being the extreme values used in the data
e.g.Plot Values 0 100 10 50 represents x values of 0 on the left to 10 to the right, and y values of 50 at the bottom to 100 to the top
After the values are declared, all plotting in the central area uses macros beginning with the keyword Plot, and the coordinates are the values in the data
Macros
This panel lists and describes all macros used in this version of MacroPlot by Javascript. They are divided into the following sub-panels
Initialization and settings
Plotting areas, coordinates used, and drawing of x and y axis
Drawing lines, bars, dots, text, and other shapes
Initialization
This sub-panel lists those macros that initialized the bitmap, and set the parametrs for drawing
Initialize Plotting
Bitmap Initialize w h r g b t is the first and obligatory macro, which Initializes the bitmap
w and h are width and height of the bitmap in number of pixels. The most common dimensions are
w=700 and h= 500 for landscape orientation
w=500 and h=700 for portrait orientation
Both 500 for square bitmap
r g b t represents red, green, blue and transparency values for the background, each value is 0 for non-existence to 255 for maximum intensity. The most commonly used background is white (255 255 255 255)
For most plotting programs in StatsToDo the macro used is Bitmap Initialize 700 500 255 255 255 255, a landscape orientation with white background
Settings for lines
The settings provide parameters for all subsequent plotting until the parameter is reset
Line Color r g b t sets the line color of red, green, blue and transparency values, each value is 0 for non-existence to 255 for maximum intensity. On initialization of the bitmap, line color is lines is set by default to black (0 0 0 255)
Line Thick p sets the thickness of lines to p pixels. On initialiszation, the default setting is 3 pixels for line thickness
Settings for fills
When bars, dots, arcs and wedges are plotted, the interior of these symbols are called fills, and they are set as follows
Fill Color r g b t sets the filling color of red, green, blue and transparency values, each value is 0 for non-existence to 255 for maximum intensity. On initialization of the bitmap, fill color is lines is set by default to black (0 0 0 255).
Fill Type t sets how the fills are to be used, t can be one of the following
t=0: only the outline, defined by the line parameters, are plotted. Fill is ignored
t=1: only fill is carried out, outline is ignored
t=2: both outline and fill are plotted
When the plot is initialized, the default setting for fill type is t=1
Settings for fonts
These set the font characteristics for text output. Please note: settings for lines and fills for fonts are separate and independent to those for general line and shape plottings
Font Face name sets the font face. The program will accept all fonts supported by the user's border. The 3 fonts accepted by all browsers are serif, sans-serif, and monospace. On initialization, sans-serif is set by default
Font Style s where s can be either normal or bold. On initialization the default setting is bold
Font Size h where h is the height of the text in pixels. On initialization, the default font size is set to 16
Font Thick p where p is the thickness of the outline of the font. On initialization, this is set to p=1
Font LColor r g b t sets the color of the outline of the font. On initialization this is set to black (0 0 0 255)
Font FColor r g b t sets the fill color of the of the font. On initialization this is set to black (0 0 0 255)
Font Color r g b t sets both LColor and FColor to the same color. On initialization this is set to black (0 0 0 255)
Font Type t where t determines which part of the font is drawn, and can be one of the following
t=0: only the outline of the font, defined by the thick and LColor parameter is drawn
t=1: only the fill of the font is drawn
t=2: both outline and fill are drawn
When the plot is initialized, the default setting for Font type is t=1
Please Note: When the bitmap is initialized, the default settings, which are suitable for most situations, are automatically set, so users need not worry about these settings unless he/she has a different preference.
Axis & Coordinates
This sub-panel presents macros that define the plotting areas, and creating the x and y axis for plotting
Drawing on the bitmap
When plotting on the initialized bitmap
the horizontal coordinate x is the number of pixels from the left border
the vertical coordinate y is the number of pixels from the top border
The macro used begins with the keyword Bitmap
Drawing on the plotting area
In most cases, there is a need to draw and label the x and y axis, and drawing coordinates used are the actual values of the data. The macros used for these all begins with the keyword Plot, and are purposes are as follows
Plot Pixels lp tp rp bp defines an area for plotting
lp defines the left border of the plotting area, in the number of pixels from the left border of the bitmap. In most cases this is 15% of the bitmap's width
tp defines the top of the plotting area, in the number of pixels from the top border of the bitmap. In most cases this is 5% of the height
rp defines the right border of the plotting area, in the number of pixels from the left border of the bitmap. In most cases this is 95% of the width (or 5% from the right border of the bitmap)
bp defines the bottom border of the plotting area, in the number of pixels from the top border of the bitmap. In most cases this is 85% of the height (or 15% from the bottom)
An example is that is that, in a landscape orientated bitmap of 700 pixels width and 500 pixel height, Plot Pixels 105 25 665 425 sets the central area for plotting that is 15% from the left and bottom, and 5% from the top and right.
This macro is usually not necessary if the 5%/15% setting suits the user, as this is the default setting when the bitmap is initialized
Plot Values lv tv rv bv defines the data values to be used in plotting
lv is the extreme data value for the horizontal variable x on the left
tv is the extreme data value for the vertical variable y at the top
rv is the extreme data value for horizontal variable x on the right
bv is the extreme data value for the vertical variable y at the bottom
Plot Logx 1 sets the horizontal x axis to the log scale. Normal scale is set on initialization, or reset by Plot Logx 0
Plot Logy 1 sets the vertical y axis to the log scale. Normal scale is set on initialization, or reset by Plot Logy 0
Plot XLabel label distance places the label for the horizontal x axis, below the bottom of the plotting area
lable is a single word text string, using the underscore _ to represent spaces if necessary
space is the number of pixels between the bottom of the plot area and the label text string
Plot YLabel label distance places the label for the vertical y axis, on the left of plotting area
lable is a single word text string, using the underscore _ to represent spaces if necessary
space is the number of pixels between the left of the plot area and the label text string
The quickest and easiest way to draw axis
The following 4 macros are sufficient to draw the x and y axis under most circumstances
Plot XAxis y nsIntv nbIntv len gap line will mark out and numerate the horizontal x axis
y is the y value on which the x axis lie
nsIntv is the number of small intervals between the vertical line marks, 10 to 20 are recommended
nbIntv is the number of big intervals between the numerical scales, 5 to 10 are recommended
len is the length of the mark in pixels, +ve value downwards and negative value upwards. -10 is recommended
gap is the number of pixels between the numerical scaling text and the y value of the axis, +ve values for text below axis and negative value for text above axis. 3 is recommended
Line determines the axis line is drawn, 0 for no line, 1 for line
Plot YAxis x nsIntv nbIntv len gap line will mark out and numerate the vertical y axis
x is the x value on which the y axis lie
nsIntv is the number of small intervals between the horizontal line marks, 10 to 20 are recommended
nbIntv is the number of big intervals between the numerical scales, 5 to 10 are recommended
len is the length of the mark in pixels, +ve value to the right and negative value to the left. 10 is recommended
gap is the number of pixels between the numerical scaling text and the y value of the axis, +ve values for text to the right of axis and negative value for text to the left of axis. -3 is recommended
Line determines the axis line is drawn, 0 for no line, 1 for line
Plot AutoXLogScale y len gap line will mark and numerate the x axis if it is in log scale
The x axis must be set to the log scale by Plot Logx 1. If axis not set to log this macro will abort
y is the y value on which the x axis lie
len is the length of the mark in pixels, +ve value downwards and negative value upwards. -10 is recommended
gap is the number of pixels between the numerical scaling text and the y value of the axis, +ve values for text below axis and negative value for text above axis. 3 is recommended
Line determines the axis line is drawn, 0 for no line, 1 for line
Plot AutoYLogScale x len gap line will mark and numerate the y axis if it is in log scale
The y axis must be set to the log scale by Plot Logy 1. If axis not set to log this macro will abort
x is the x value on which the x axis lie
len is the length of the mark in pixels, +ve value downwards and negative value upwards. -10 is recommended
gap is the number of pixels between the numerical scaling text and the y value of the axis, +ve values for text below axis and negative value for text above axis. 3 is recommended
Line determines the axis line is drawn, 0 for no line, 1 for line
Other methods of drawing axis
Users may wish to draw individual part of the axis, and the following macros can be used
Plot XLine y Draws the horizontal x axis line at the y value y
Plot YLine x Draws the vertical y axis line at the x value y
Plot XMark y begin interval len marks the horizontal x axis with a series of vertical marks
y is the y value where the axis is to be marked
begin is the value for the first mark
interval is the interval between marks
len is the length of the mark line in pixels, +ve downwards, -ve upwards
Plot YMark x start interval len marks the vertical y axis with a series of horizontal marks
x is the x value where the axis is to be marked
start is the value for the first mark
interval is the interval between marks
len is the length of the mark line in pixels, +ve to the right, -ve to the left
Plot XScale y start interval gap writes the numerical scales for the horizontal x axis
y is the y value for the axis
start is the first value to be written
interval is the interval between numerical scales
gap is the space in pixels between the scale text and the axis, +ve for text below axis, -ve for text above axis
The number of decimal points in the scale is the same as that of the interval value
Plot YScale x start interval gap writes the numerical scales for the vertical y axis
x is the x value for the axis
start is the first value to be written
interval is the interval between numerical scales
gap is the space in pixels between the scale text and the axis, +ve for text to the right of axis, -ve for text to the left of axis
The number of decimal points in the scale is the same as that of the interval value
Plot XMarkIntv y interval len marks the horizontal x axis with a series of vertical marks
y is the y value of the axis
interval is the interval between the marks, beginning at 0 and while in range
len is the length of the mark line in pixels, +ve downwards, -ve upwards
Plot YMarkIntv x interval len marks the vertical y axis with a series of horizontal marks
x is the x value of the axis
interval is the interval between the marks, beginning at 0 and while in range
len is the length of the mark line in pixels, +ve to the right, -ve to the left
Plot XScaleIntv y interval gap writes the numerical scales for the horizontal x axis
y is the y value of the axis
interval is the interval between the numerical scales, beginning at 0 and while in range
gap is the space in pixels between the scale text and the axis, +ve for text below axis, -ve for text above axis
The number of decimal points in the scale is the same as that of the interval value
Plot YScaleIntv x interval gap writes the numerical scales for the vertical y axis
x is the x value of the axis
interval is the interval between the numerical scales, beginning at 0 and while in range
gap is the space in pixels between the scale text and the axis, +ve for text to the right of axis, -ve for text to the left of axis
The number of decimal points in the scale is the same as that of the interval value
Drawings
This sub-panel describes those macros that draws the plotting objects. Drawing are performed in two environments
Macros that begins with the keyword Bitmap uses pixel values as coordinates, where x is the number of pixels from the left border, and y the number of pixels from the top border
Macros that begins with the keyword Plot uses actual data values (as defined in the Plot Values lv tv rv bv macro, as coordinates
Drawing lines
The thickness and color of any line drawn is set by the Line macros (see setting sub-panel). The default setting is black line 3 pixels in width
Bitmap Line x1 y1 x2 y2 draws the line from x1y1 to x2y2
x1 and x2 are number of pixels from the left border
y1 and y2 are number of pixels from the top border
Plot Line x1 y1 x2 y2 draws the line from x1y1 to x2y2
x1 and x2 are data values for the horizontal variable x
y1 and y2 are data variables for the vertical variable y
Plot PixLine x y hpix vpix draws a line
x and y are data values for the horizonal x value and verticsl y value. This defines the coordinate at the origin of the line
hpix is the number of pixels horizontally from the origin, +ve value to the right, -ve value to the left
vpix is the number of pixels vertically from the origin, +ve value downwards, -ve value upwards
The line is then drawn between the origin and that defined by hpix and vpix
Drawing bars
The color and thickness of the outline are defined in the Line macro. The color of the fill is defined in the fill color and Fill Type macro. The default setting is black (0 0 0 255) for both line and fill color, and the Fill type is set to 1, only the fill and no outlines. These settings are suitable for most circumstances, but user can change them is so required.
Bitmap Bar x1 y1 x2 y2 draws a bar the corner of which are x1y1 and x2y2. X and y are number of pixels from the left and top border of the bitmap
Plot Bar x1 y1 x2 y2 draws a bar the corner of which are x1y1 and x2y2. X and y are data values as defined in Plot Values lv tv rv bv
Bar Wide w sets the width / height of bars for Plot VBar and Plot HBar
w is the half width of the bar, so a VBar is 2w+1 pixels in width, and HBar is 2w+1 pixels in height
The default value for w is 7 pixels (making width/height of 15 pixels), unless the user changes it
Plot VBar x y1 y2 hshift draws a vertical bar
x is the data value for the horizontal x variable. The is the center of the vertical bar
y1 and y2 are values for the vertical y variable. They define the vertical ends of the bar
hshift is the number of pixels the whole bar is shefted horizontally, +ve value to the left and +ve value to the right. In most cases this is 0 (no shift). However, if there are more than 1 bar in the same position, shifting some of them will avoid the bars overlapping and obscuring each other
The width of the vertical bar is set by default at 7, (width of bar=15 pixels)
Plot HBar x1 x2 y vshift draws a horizontal bar
x1 and x2 are data values for the horizontal x variable. They define the horizontal ends of the bar
y is the value for the vertical y variable, and defines and center of the horizontal bar
vshift is the number of pixels the whole bar is shefted vertically, -ve value upwards and +ve value downwards. In most cases this is 0 (no shift). However, if there are more than 1 bar in the same position, shifting some of them will avoid the bars overlapping and obscuring each other
Theheight of the horizontal bar is set by default at 7, (height of bar=15 pixels)
Drawing dots
There are only 2 dot types, circle and square. If more than 2 tyoes of dats are required, they can be distinguished by the colours of the outline and fill, and by their sizes. Settingsd for dot parameters are in the settings sub-panel
Bitmap Circle x y radius and Bitmap Square x y radius draws a circle or a square dot
x and y are the number of pixels from the left and top border
Radius is in number of pixels. The diameter of the dot is 2Radius+1 pixels
Plot Circle x y radius hshift vshift and Plot Square x y radius hshift vshift draws a circle or a square dot
x and y are the data values of the horizontal x variable and vertical y variable, as defined by Plot Values lv tv rv bv
Radius is in number of pixels. The diameter of the dot is 2Radius+1 pixels
hshift is the number of pixels the dot is shifted horizontally, -ve value to the left, +ve value to the right
vshift is the number of pixels the dot is shifted vertically, -ve value upwards, +ve value downwards
In most cases there is no shift (0 0), but id there are more than 1 dot in the same position, shifting avoids the dots superimposing over and obscuring each other
Dot Radius r sets the radius of the dot in pixels. The diameter of the dot is 2radius+1 pixels. The default radius is 5
Dot Type t where t is either circle or square. The default setting is circle
Plot Dot x y hshift vshift draws the dot, with its parameters (shape size color outline fill) already pre-set
x and y are the data values of the horizontal x variable and vertical y variable, as defined by Plot Values lv tv rv bv
hshift is the number of pixels the dot is shifted horizontally, -ve value to the left, +ve value to the right
vshift is the number of pixels the dot is shifted vertically, -ve value upwards, +ve value downwards
In most cases there is no shift (0 0), but if there are more than 1 dot in the same position, shifting avoids the dots superimposing over and obscuring each other
Drawing text
The color, outline, fill, font, and weight of text are preset (see settings). The default settinfs are sans-sherif, black fill only, and 16pxs high
Bitmap HText x y ha va txt draws text horizontally on the bitmap
x and y are number of pixels fom the left and top borders, and together being the reference coordinate of the text
ha is horizontal adjust
ha=0: the left end of the text is at the x coordinate
ha=1: the center of the text is at the x coordinate
ha=2: the right end of the text is at the x coordinate
va is vertical adjust
va=0: the top of the text is at the y coordinate
va=1: the center of the text is at the x coordinate
va=2: the bottom end of the text is at the x coordinate
txt is the text to be drawn. It must be a single word with no gaps. Spaces can be represented by the underscore _
Plot HText x y ha va txt hshift vshift draws text horizontally on the bitmap
x and y are data values as defined by Plot Values lv tv rv bv, and together being the reference coordinate of the text
ha is horizontal adjust
ha=0: the left end of the text is at the x coordinate
ha=1: the center of the text is at the x coordinate
ha=2: the right end of the text is at the x coordinate
va is vertical adjust
va=0: the top of the text is at the y coordinate
va=1: the center of the text is at the x coordinate
va=2: the bottom end of the text is at the x coordinate
txt is the text to be drawn. It must be a single word with no gaps. Spaces can be represented by the underscore _
hshift is the number of pixels the text is shifted horizontally, -ve value to the left, +ve value to the right
vshift is the number of pixels the text is shifted vertically, -ve value upwards, +ve value downwards
In most cases there is no shift (0 0), but if there are other structures in the same position, shifting avoids the text and structures obscuring each other
Bitmap VText x y ha va txt draws text vertically (90 degrees anticlockwise from horizontal) on the bitmap
x and y are number of pixels fom the left and top borders, and together being the reference coordinate of the text
ha is horizontal adjust
ha=0: the left end of the text is at the x coordinate
ha=1: the center of the text is at the x coordinate
ha=2: the right end of the text is at the x coordinate
va is vertical adjust
va=0: the top of the text is at the y coordinate
va=1: the center of the text is at the x coordinate
va=2: the bottom end of the text is at the x coordinate
txt is the text to be drawn. It must be a single word with no gaps. Spaces can be represented by the underscore _
Plot VText x y ha va txt hshift vshift draws text vertically (90 degrees anticlockwise from horizontal) on the bitmap
x and y are data values as defined by Plot Values lv tv rv bv, and together being the reference coordinate of the text
ha is horizontal adjust
ha=0: the left end of the text is at the x coordinate
ha=1: the center of the text is at the x coordinate
ha=2: the right end of the text is at the x coordinate
va is vertical adjust
va=0: the top of the text is at the y coordinate
va=1: the center of the text is at the x coordinate
va=2: the bottom end of the text is at the x coordinate
txt is the text to be drawn. It must be a single word with no gaps. Spaces can be represented by the underscore _
hshift is the number of pixels the text is shifted horizontally, -ve value to the left, +ve value to the right
vshift is the number of pixels the text is shifted vertically, -ve value upwards, +ve value downwards
In most cases there is no shift (0 0), but if there are other structures in the same position, shifting avoids the text and structures obscuring each other
Other miscellaneous drawings
Bitmap Arc x y radius startDeg endDeg rotate draws an arc.
x and y are number of pixels from the left and top border, and together form the center of the arc
radius is the radius of the arc, in number of pixels
startDeg and endDeg are the degrees (360 degrees in full circle) of the arc
rotate defines the direction of the arc, 0 for clockwise, 1 for anti-clockwise
Bitmap Wedge x y radius startDeg endDeg shift rotate draws a wedge, essentially an arc with lines to the center
x and y are number of pixels from the left and top border, and together form the center of the wedge
radius is the radius of the edge, in number of pixels
startDeg and endDeg are the degrees (360 degrees in full circle) of the wedge
shift is the number of pixels that the wedge is moved centrifugally (away from the center). This is used in pie charts to separate the wedges of the pie
rotate defines the direction of the wedge, 0 for clockwise, 1 for anti-clockwise
Plot Curve a b1 b2 b3 b4 b5 x1 x2 draws a polynomial curve
The curve is y=a + b1x + b2x2 + b3x3 + b4x4 + b5x5. Where higher power is not needed, 0 is used to represent the the coefficient b
The curve is drawn from data value x from x1 to x2
Plot Normal mean sd height draws a normal distribution curve
mean and sd (Standard Deviation) are as in the data horizontal variable variable x
height is the maximum height (where x=mean) of the curve as in the vertical variable y
Color Palettes
Plain Colors
0 0 0 #000000
0 0 63 #00003f
0 0 127 #00007f
0 0 191 #0000bf
0 0 255 #0000ff
0 63 0 #003f00
0 63 63 #003f3f
0 63 127 #003f7f
0 63 191 #003fbf
0 63 255 #003fff
0 127 0 #007f00
0 127 63 #007f3f
0 127 127 #007f7f
0 127 191 #007fbf
0 127 255 #007fff
0 191 0 #00bf00
0 191 63 #00bf3f
0 191 127 #00bf7f
0 191 191 #00bfbf
0 191 255 #00bfff
0 255 0 #00ff00
0 255 63 #00ff3f
0 255 127 #00ff7f
0 255 191 #00ffbf
0 255 255 #00ffff
63 0 0 #3f0000
63 0 63 #3f003f
63 0 127 #3f007f
63 0 191 #3f00bf
63 0 255 #3f00ff
63 63 0 #3f3f00
63 63 63 #3f3f3f
63 63 127 #3f3f7f
63 63 191 #3f3fbf
63 63 255 #3f3fff
63 127 0 #3f7f00
63 127 63 #3f7f3f
63 127 127 #3f7f7f
63 127 191 #3f7fbf
63 127 255 #3f7fff
63 191 0 #3fbf00
63 191 63 #3fbf3f
63 191 127 #3fbf7f
63 191 191 #3fbfbf
63 191 255 #3fbfff
63 255 0 #3fff00
63 255 63 #3fff3f
63 255 127 #3fff7f
63 255 191 #3fffbf
63 255 255 #3fffff
127 0 0 #7f0000
127 0 63 #7f003f
127 0 127 #7f007f
127 0 191 #7f00bf
127 0 255 #7f00ff
127 63 0 #7f3f00
127 63 63 #7f3f3f
127 63 127 #7f3f7f
127 63 191 #7f3fbf
127 63 255 #7f3fff
127 127 0 #7f7f00
127 127 63 #7f7f3f
127 127 127 #7f7f7f
127 127 191 #7f7fbf
127 127 255 #7f7fff
127 191 0 #7fbf00
127 191 63 #7fbf3f
127 191 127 #7fbf7f
127 191 191 #7fbfbf
127 191 255 #7fbfff
127 255 0 #7fff00
127 255 63 #7fff3f
127 255 127 #7fff7f
127 255 191 #7fffbf
127 255 255 #7fffff
191 0 0 #bf0000
191 0 63 #bf003f
191 0 127 #bf007f
191 0 191 #bf00bf
191 0 255 #bf00ff
191 63 0 #bf3f00
191 63 63 #bf3f3f
191 63 127 #bf3f7f
191 63 191 #bf3fbf
191 63 255 #bf3fff
191 127 0 #bf7f00
191 127 63 #bf7f3f
191 127 127 #bf7f7f
191 127 191 #bf7fbf
191 127 255 #bf7fff
191 191 0 #bfbf00
191 191 63 #bfbf3f
191 191 127 #bfbf7f
191 191 191 #bfbfbf
191 191 255 #bfbfff
191 255 0 #bfff00
191 255 63 #bfff3f
191 255 127 #bfff7f
191 255 191 #bfffbf
191 255 255 #bfffff
255 0 0 #ff0000
255 0 63 #ff003f
255 0 127 #ff007f
255 0 191 #ff00bf
255 0 255 #ff00ff
255 63 0 #ff3f00
255 63 63 #ff3f3f
255 63 127 #ff3f7f
255 63 191 #ff3fbf
255 63 255 #ff3fff
255 127 0 #ff7f00
255 127 63 #ff7f3f
255 127 127 #ff7f7f
255 127 191 #ff7fbf
255 127 255 #ff7fff
255 191 0 #ffbf00
255 191 63 #ffbf3f
255 191 127 #ffbf7f
255 191 191 #ffbfbf
255 191 255 #ffbfff
255 255 0 #ffff00
255 255 63 #ffff3f
255 255 127 #ffff7f
255 255 191 #ffffbf
255 255 255 #ffffff
Color Palletes
Table of colors used on this web site
255 255 255 #ffffff
224 224 224 #e0e0e0
128 128 128 #808080
128 0 0 #800000
255 0 0 #ff0000
96 48 96 #603060
48 16 64 #301040
96 96 160 #6060a0
160 160 96 #a0a060
160 160 0 #a0a000
153 191 164 #99bfa4
160 160 96 #a0a060
97 24 0 #611800
204 63 200 #cc3fc8
224 224 224 #e0e0e0
Patterns of complementary colors
A
105 93 70 #695d46
255 113 44 #ff712c
207 194 145 #cfc291
161 232 217 #a1e8d9
255 246 197 #fff6c5
B
115 0 70 #730046
201 60 0 #c93c00
232 136 1 #e88801
255 194 0 #ffc200
191 187 17 #bfbb11
C
97 24 0 #611800
140 115 39 #8c7327
71 164 41 #47a429
153 191 164 #99bfa4
242 239 189 #f2efbd
D
20 87 110 #14576e
140 33 90 #8c215a
230 133 38 #e68526
195 102 163 #c366a3
242 207 242 #f2cff2
E
64 1 1 #400101
48 115 103 #307367
96 166 133 #60a685
242 236 145 #f2ec91
229 249 186 #e5f9ba
F
55 89 21 #375915
166 60 60 #a63c3c
115 108 73 #736c49
166 157 129 #a69d81
242 224 201 #f2e0c9
G
115 36 94 #73245e
166 69 33 #a64521
217 182 78 #d9b64e
242 218 145 #f2da91
242 242 242 #f2f2f2
H
255 77 0 #ff4d00
102 87 71 #665747
125 179 0 #7db300
153 138 122 #998a7a
217 195 98 #d9c362
I
128 0 38 #800026
128 128 83 #808053
92 153 122 #5c997a
163 204 143 #a3cc8f
255 230 153 #ffe699
Explanations
Introduction
This page discusses Receiver Operator Characteristics (ROC), a method of evaluating predictive tests, where the test is a scalar variable
Historical Aspects : During the Second World War, the British invented the RADAR which reflects a radio wave against an object, and so were able to detect the German bombers coming over the channel. The early versions of RADAR was imprecise, and the signal contained much electronic noise and difficult to interpret. If the alarm was raised with a weak signal, there was a risk of false signal, wasting much fuel and energy in response. If the alarm was not raised until a clear signal is obtained, the risk was that the fighters were scrambled too late and more bombs would be dropped on the cities. In order to analyse the signal and make decisions on how to respond, the scientist developed a statistical method of handling the signals, and named this the RADAR Receiver Operator Characteristics. The method became widely used in signal analysis in many aspects of science and industry, and adopted in the analysis of tests and diagnosis in Medicine, under the term Receiver Operator Characteristics (ROC), with the RADAR part removed.
Theoretical Considerations :
The model is that of using a scalar measurement, preferably normally distributed, as a Test to predict a binary Outcome. For example using maternal height
(Test) to predict the need for Caesarean Section to deliver the baby (Outcome). The relationship between Test and Outcome is best demonstrated as the diagram to the right.
In a sample that was delivered without Caesarean Section (Outcome Negative O-, red), the normal distribution curve defines the
height we will use to make a binary decision whether it is Test Positive or Negative.
Values of Test less than the decision line (shorter women, maroon) represents the number of False Positives (FP)
Values of Test greater than the decision line (taller women, red), represents the True Negatives (TN)
In a sample that was delivered by Caesarean Section (Outcome Positive O+, blue), the normal distribution curve defines the
height we will use to make a binary decision whether it is Test Positive or Negative.
Value of Test less than the decision line (shorter women, blue) represents the number of True Positives (TP)
Value of Test greater than the decision line (taller women, navy), represents the false negatives (FN)
If the value used to make the decision changes, in our example, if the maternal height we used to predict Caesarean Section changes, then
TP,FP,FN, and TN also changed, and the TPR and FPR changed accordingly.
The changing relationship between FPR and TPR forms a curve, as shown in the diagram to the left. This curve is called the
Receiver Operator Characteristics Curve (ROC Curve), and the area under this curve is called the Area Under the ROC, theta,
usually represented by the abbreviation θ
In a perfect test, where the values of the test from Outcome Positives do not overlap those from Outcome Negatives, TPR
will increase from 0 to 1 while FPR remains at 0. TPR will then remain at 1 while FPR increases from 0 to 1. In other words,
the ROC curve hugs the left and top border, and the area under it θ=1
In a completely useless test, the values of measurement from Outcome Positives and Outcome Negatives overlap completely, so that
the TPR and FPR increase together. The ROC curve is therefore the diagonal, and the Area under it θ=0.5
In most cases, there is partial overlap of values, and the ROC curve looks pretty much like that in the diagram above and to
the left, with a value between 0.5 and 1
The null value for θ is therefore 0.5, a useful test has a 95% confidence interval of θ that is greater
than 0.5. Where θ<0.5, the test predicts the opposite of the intended outcome.
Unpaired ROC
H
L
1
147.5
1
147.5
1
149.0
1
150.0
1
150.5
1
151.0
1
151.5
0
152.5
1
152.5
1
152.5
0
153.5
0
153.5
1
153.0
0
154.0
0
154.0
1
153.5
1
153.5
1
154.0
1
154.0
1
154.0
0
155.5
0
156.0
0
156.0
0
156.0
1
155.5
1
155.5
1
156.0
1
156.0
1
156.0
0
157.0
1
156.5
1
156.5
0
157.5
0
157.5
1
157.5
0
158.5
0
158.5
0
158.5
0
158.5
0
158.5
0
159.0
0
159.0
1
158.5
0
159.5
0
159.5
1
160.0
0
161.5
0
161.5
0
162.0
0
162.5
The first two columns of the default example data from the Javascript program will be used to demonstrate how
a single ROC is calculated and interpreted. Please note that the data is generated by the computer to demonstrate the method,
and not real clinical observations
Reference Data
We wish to use the maternal height as the Test to predict the need for Caesarean Section as the Outcome.
We reviewed our medical records and samples 25 cases that were delivered vaginally and 25 cases delivered by Caesarean Section,
and recorded the maternal height. The data is as shown in the table to the right.
Column 1 shows the outcome, with 0 represent vaginal delivery (Outcome Negative, O-) and 1 Caesarean Section (Outcome Positive,
O+). As the higher value (1) represent Outcome Positive (O+), the first row of column 1 is H
Column 2 shows the test values, maternal height in cms. As a reduced height (lower value) is used to predict Caesarean
Section (O+), the first row of column 2 is L for low values to be Test Positive.
Theoretical Discussions
The plot to the left shows the distribution of the data points. Those requiring Caesarean Section (O+) are on
the left and those delivered vaginally (O-) on the right.
If we were to arbitrarily draw a decision line at maternal height
of 155cms, as shown in the diagram, the 15 cases below that line on the left would be True Positives (TP=15), as they are
Test Positive and Outcome Positive. The 10 cases above the line on the left would be False Negatives (FN=10), as they are
Test Negative but Outcome Positive. The 5 cases below the line on the right would be False Positives (FP=5), as they are
Test Positive but Outcome Negative. The 20 cases above the line on the right would be True Positives (TP=20), as they are
Test Negative and Outcome Negative. The calculated derivatives, the True Positive Rate is then TPR = TP / (TP + FN) = 15 / 25
= 0.6, and the False Positive Rate FPR = FP / (FP + TN) = 5 / 25 = 0.2
If the decision line is moved upward towards higher values, the number of positives, both true and false would increase and
the number of negatives, both true and false, would decrease. If the decision line is moved downwards towards lower values,
the reverse follows. The TP, FP, FN, TN, and their calculated derivatives of TPR and FPR, therefore changes as the decision line
moves throughout the whole range of the test values. The relationships between TPR and FPR over the range of the values form
the Receiver Operator Characteristic Curve, as shown in the diagram to the left.
Using the ROC to set the decision cut off value
Looking at the diagram to the left, We can see that, if we were to set the cut off value for decision at 160cms, 24 out of 25
cases that had Caesarean Section would be True Positive, but 21 out of 25 cases delivered vaginally would become False Positive,
making True Positive Rate TPR = 24/25 = 0.96 and False Positive Rate FPR = 21/25 = 0.84.
At the other extreme of setting the cut off value at 153cms, 9 out of 25 are True Positives and 1 out of 25 False Negatives, making
the True Positive Rate TPR = 9/25 = 0.36 and the False Positive Rate FPR = 1/25 = 0.04
A clinician given this set of data may choose a cut off value anywhere between these extremes to suit his/her purposes. The common approach is to set decision cut offs according to the purposes for using the test, and they are as follows
The most efficient prediction point
Using a measure of accuracy, the Youden Index, YI=(TPR + TNR) / 2 = (TPR-FPR+1)/2, and a value of the test where YI is maximum
Using a point on the ROC where the value is results in Q*, where Q* = FPR where TPR=1-FPR
For epidemiological screening or early clinical alerts. This prioritize TPR over TNR, so that a cut off value where TPR is x2
or x3 that of TNR
For decision to take action, particularly if the action involves risks or costs. This prioritize TNR over TPR, so that a
cut off value where TNR is x2 or x3 that of TPR
Interpreting and Using Results of the ROC
Using the first 2 columns of the default example data from the Javascript program panel, using maternal height to
predict the need for Caesarean Section, the results are interpreted as follows.
Ht(cms)
FPR
TPR
FNR
TNR
YI
LR+
LR-
160
0.84
0.96
0.04
0.16
0.12
1.14
0.25
159.5
0.76
0.96
0.04
0.24
0.2
1.26
0.17
159
0.68
0.96
0.04
0.32
0.28
1.41
0.13
158.5
0.48
0.92
0.08
0.52
0.44
1.92
0.15
157.5
0.4
0.88
0.12
0.6
0.48
2.2
0.2
157
0.36
0.88
0.12
0.64
0.52
2.44
0.19
156.5
0.36
0.8
0.2
0.64
0.44
2.22
0.31
156
0.24
0.68
0.32
0.76
0.44
2.83
0.42
155.5
0.2
0.6
0.4
0.8
0.4
3
0.5
154
0.12
0.48
0.52
0.88
0.36
4
0.59
153.5
0.04
0.4
0.6
0.96
0.36
10
0.63
153
0.04
0.36
0.64
0.96
0.32
9
0.67
The ROC value θ = 0.81, Standard Error = 0.06, 95% Confidence interval = 0.70 to 0.93. As the 95% confidence interval
does not overlap the null value of 0.5, maternal height can be concluded as a significant predictor of the need for Caesarean
Section.
The parameters are as shown in the table to the right, from which the following decisions can be made
The maximum Youden Index is 0.52, where maternal height is 157cms
Q* is when TPR = TPR = 0.75 (approximately), where maternal height = 156.2cms
Approximately therefore, the most accurately cut off value to predict the need for Caesarean Section is a maternal height
of 156cms to 157cms.
At a maternal height of 159cms, the TPR is 0.96, which is x3 that if TNR(1-FPR) of 0.32. This can be take as a cut off
for alert. For example, that junior staff should be required to consult someone more experienced to make clinical
decisions when maternal height is less than 159cms
At 153cms, the TPR is 0.36, against a TNR (1-FPR) of 0.96, so that TNR is roughly x3 that of TPR. This can be taken as a
cut off level for action, for example, to proceed to an elective Caesarean Section.
The table to the right also provides the Likelihood Ratios that can be used to calculate Bayesian post-test probabilities from
pre-test probabilities under differing clinical situations. The procedures for doing so are discussed in the Prediction page
Unpaired Comparison of Two ROCs
Unpaired comparisons of ROCs are used to compare the predictive quality of a test under different conditions in different
populations. An example is comparing the ROC using maternal height to predict Caesarean Section in nullipara and multipara,
or between women from urban and rural communities.
The comparison uses the two ROCs and their Standard Errors, where
Difference = θ1 - θ1
SEDiff = sqrt(SE12 + SE22)
95% Confidence Interval of the Difference = Diff ±zSEDiff, where z=1.65 for the one tail model, and 1.96
for the two tail model.
Paired ROC comparisons allow the comparisons between different tests for the same outcome, by administering all the tests in the
same individuals. Such a comparison is powerful in that intra-subject comparisons are made, reducing the influence of between subject variations. The procedure used is as described by Delong et.al., (see references). This algorithm is particularly attractive, in that it is nonparametric, so allowing for the comparison between measurements of different distributions, providing that they are scalar, and at least ordinal.
H
L
H
H
1
147.5
30
27
1
147.5
28
25
1
149.0
25
25
1
150.0
36
29
1
150.5
31
24
1
151.0
34
26
1
151.5
21
22
0
152.5
37
22
1
152.5
23
29
1
152.5
30
23
0
153.5
35
23
0
153.5
39
28
1
153.0
35
25
0
154.0
32
26
0
154.0
25
24
1
153.5
30
32
1
153.5
28
24
1
154.0
27
27
1
154.0
37
28
1
154.0
35
30
0
155.5
23
24
0
156.0
34
24
0
156.0
28
24
0
156.0
28
23
1
155.5
27
28
1
155.5
30
30
1
156.0
23
29
1
156.0
28
31
1
156.0
36
29
0
157.0
29
23
1
156.5
21
25
1
156.5
24
31
0
157.5
25
24
0
157.5
21
27
1
157.5
39
25
0
158.5
29
27
0
158.5
30
24
0
158.5
35
26
0
158.5
30
23
0
158.5
27
27
0
159.0
27
23
0
159.0
31
20
1
158.5
37
24
0
159.5
33
21
0
159.5
33
27
1
160.0
31
23
0
161.5
31
29
0
161.5
32
26
0
162.0
25
24
0
162.5
29
24
The data used for demonstration in this panel is the default data from the Javascript program panel. In this exercise,
we wish to compare 3 Tests to predict the need for Caesarean Section, these being maternal height (cms), maternal age (years),
and maternal BMI. We have collected data from 25 mothers who delivered by Caesarean Section, and 25 delivered vaginally, the
data are as in the table to the right.
Column 1 is the outcome, 0 vaginal delivery (Outcome Negative, O-) and 1 for Caesarean Section (Outcome Positive, O+). As
the higher value 1 is for O+, H is placed in the first row of column 1
Column 2 is Test 1, maternal height in cms. As lower value (shorter) is used to predict O+, L is placed in the first row of column 2
Column 3 is Test 2, maternal age in years. As higher value (older) is used to predict O+, H is placed in the first row
of column 3
Column 4 is Test 3, maternal Body Mass Index (BMI). As higher value (fatter) is used to predict O+, H is placed in the
first row of column 4
Results
1
0.065
-0.004
0.065
1
0.069
-0.004
0.069
1
The table to the left shows correlation between the 3 tests, and these must be used to correct the differences between the 3 θs.
After correction, the test for heterogeneity between the 3 θs is chi square=10.39, df=2,p=0.006. This is statistically highly significant, allowing an interpretation that the 3 θs are different to each other.
ROC
θ
SEθ
95%CI
1. Height
0.81
0.06
0.70 to 0.93
2. Age
0.50
0.08
0.33 to 0.66
3. BMI
0.73
0.07
0.60 to 0.87
The 3 ROC curves are plotted as shown in the diagram to the right, maternal height in red, age in green, and BMI in blue. The
θ values are shown in the table to the left. The 95% confidence intervals for θ of Maternal height and BMI are greater than 0.5, indicating they are significant predictors of outcome. The 95% confidence interval of Maternal age(0.33-0.66) traverse the null value of 0.5, indicating that it is not a significant predictor.
The 3 ROCs can also be repeatedly compared pairwise, and the results shown in the table below and to the left.
Diff=difference between the two θs
r = correlation between the two ROCs
SEDiff = Standard Error of the difference, corrected by correlation
95%CI = 95% confidence interval of the difference, Diff±2.41SEDiff.
There are 3 comparisons, so the Bonferroni's correction for p=0.05 is 0.05/3=0.017. For a two tail model, p=0.017/2=0.008,
and z for probability of 0.008 is 2.41. This differs from a single comparison where the 95% confidence interval is
Diff±1.96SEDiff, where 1.96 is z for 0.025 (0.05/2)
θ1
SE1
θ2
SE2
r
Diff
SEDiff
95%CI
0.81
0.06
0.50
0.08
0.065
0.032
0.10
0.079 to 0.561
0.81
0.06
0.73
0.07
-0.004
0.08
0.097
-0.154 to 0.314
0.50
0.08
0.73
0.07
0.069
-0.239
0.106
-0.495 to 0.017
From these results, it can be seen that maternal height is the best predictor, significantly better than maternal age.
Maternal BMI is second best, but it's θ is not significantly different to maternal height or age.
References
Hanley JA, McNeil BJ (1982) The meaning and use of the Area Under a Receiver
Operating Characteristic (ROC) curve. Radiology 143:29-36
DeLong ER, DeLong DM, Clarke-Pearson DL (1988) Comparing the areas under two
or more correlated receiver operating characteristic curves: a nonparametric approach. Biometrics 44:837-845
Javascript Program
Data
All data must have the same number of columns Rows - The first row consists of a dingle character H or L
- Column 1 : H = high value, and L = low value, representing Outcome Positive
- Other columns : H = high value, and L = low value, for Outcome Positive
Columns
- Column 1 is an integer for Outcome. Only highest and lowest values used
- Other columns are values of predictors
If the value used to make the decision changes, in our example, if the maternal height we used to predict Caesarean Section changes, then
TP,FP,FN, and TN also changed, and the TPR and FPR changed accordingly.
The table to the left shows correlation between the 3 tests, and these must be used to correct the differences between the 3 θs.
After correction, the test for heterogeneity between the 3 θs is chi square=10.39, df=2,p=0.006. This is statistically highly significant, allowing an interpretation that the 3 θs are different to each other.
