VARSUM: Variable Distribution Summaries

Last updated 26 May 98

VARSUM prints two-way distributions of variables versus groups. A maximum of ten groups (columns) will be printed per page. Both frequencies and percentages can be printed for any variable requested. Computed variables C0001-C0006 and background variables more than eight characters in length cannot be used.

Program Invocation

The specific syntax for program invocation varies between operating systems. This document diplays the code for the AIX version.


@codap varsum <opt> <ssss> <CDf> <TFf> [<codes>] [<vcodes>]

ssss:     The study number
opt:  A   Do not print "Interval frequencies" or "Interval percentages"
          on the label.
      F   Print frequency tables only
      P   Print percentage of total tables only
      B   Print both frequency and percentage of total
      J   Print percentage of valid tables only
      K   Print both frequency and percentage of valid
CDf:      Input Case Data file
TF7:      Input Task Factor file
codes:    Input Codes Values file (optional).  File format can be found in
	  the Common Cards document.
vcodes:   Input Variable Title Codes file (optional, for replacing background
	  variable titles).  File format is described below.

Variable Title Codes file

This file type is only used by VARSUM. It allows the user to replace variable titles with longer, more descriptive titles.


<id> <title>

id:      cc 01-05  The background variable ID
title:   cc 07-132 The background variable title

Multi-line titles must contain either the variable ID or blanks in columns 01- 05. VARSUM is limited to the first three lines of each title. This file should be limited to only those variable titles which need to be replaced. Titles do not need to be in sequence.

VARSUM Control Card


VARSUM <study> <title>

VARSUM:   cc 01-06  The literal 'VARSUM'
study:    cc 08-11  The study number
title:    cc 13-72  The title to use for this run.

Report Note Cards (optional)

The cards in this section are textual notes that are to be printed on the report. There is no limit on the number of note cards which may be used. All cards found between the 'NOTE' card and the '@EOF' card will be treated as notes and will not be scanned as control cards.


NOTE
...notes...
@eof

Variable Request Cards

The variable request cards specify which variables to distribute. The user may specify upper and lower limits, interval size, and type of table(s) to report.

There are two separate formats for this card - one for computed variables and one for background variables.

Background Variable Request Cards


<var> <min> <max> <int> <t> <c> <m> <o> <v>

var:   cc 01-05  The type and index of the selected variable
min:   cc 07-14  The minimum acceptable value for this variable.  
                 If not specified, the actual minimum is used.
max:   cc 16-23  The maximum acceptable value for this variable.
                 If not specified, the actual maximum is used.
int:   cc 25-32  The interval size
t:     cc 34     Table flag ( 1 = print table, 0 = do not print) 
c:     cc 35     Count flag ( 1 = print total counts ) 
m:     cc 36     Mean and s.d. flag ( 1 = print means and s.d.)
o:     cc 37     Other (not counted) flag ( 1 = print ) 
v:     cc 38     Option override flag.  F = print frequency tables only,
		 P = percentage tables only, B = both tables

Computed Variable Request Cards


<var> <min> <max> <int> <t>< c><m> ;<o>< ;v> <end>

var:   cc 01-05  The type and index of the selected variable
min:   cc 07-14  The minimum acceptable value for this variable. If not
		 specified, the actual minimum is used.
max:   cc 16-23  The maximum acceptable value for  this variable If not
		 specified, the actual maximum is used.
int:   cc 25-32  The interval size
t:     cc 34     Table flag ( 1 = print table, 0 = do not print) 
c:     cc 35     Count flag ( 1 = print total counts ) 
m:     cc 36     Mean and s.d. flag ( 1 = print means and s.d.)
o:     cc 37     Other (not counted) flag ( 1 = print ) 
v:     cc 38     Option override flag.  F =  print frequency tables only,
		 P = percentage tables only, B = both tables
end:   cc 40-47  Extension of final interval

Variable request cards are terminated with an @eof image.

Group Request Cards

The group request cards specify which groups to distribute. The user may specify up to three lines of column titles and may also supply a new group title.


<group> <ct1> <ct2> <ct3> <title>
group:  cc 01-06  The group ID
ct1:    cc 08-17  Column title line 1
ct2:    cc 18-27  Column title line 2
ct3:    cc 28-37  Column title line 3
title:  cc 38-80  Replacement group title

Group request cards are terminated with an @eof image.

Example

@codap varsum f ssss cd100 tf100 codes vtcodes
VARSUM ssss This is the VARSUM report title
NOTE
Some note card stuff, etc
so on and so forth
@eof
C0043 0.0      10.0     1.0      1111  90.0
V0003        3       99        5 1111b 
V0004 E1       E3                1101
V0004 E4       E6                1101
V0004 E7       E9                1101
V0012 72330    72390          10 1101
@eof
GP0001
GP0003
ST0171
@EOF

The distribution for variable C0043 would include intervals 0.0 - 0.9999, 1.0 - 1.9999, ... , 9.0 - 9.9999, and 10.0 - 100.0. This last interval is caused by the use of the <end> field on the control card. The interval field for V0003 causes this variable to be treated as number, while V0004 is treated as alpha. Remember that alpha variables must be left-justified, while numeric variable values may be located anywhere in their fields. Also, the mean flag cannot be set for alpha variables. The VTCODES file will be scanned for alternative titles for V0003 and V0004.

Back to document index