PRTMOD collects all the data vectors requested from a MODSET file, optionally sorts the data, and prints the data in a report formatted according to user defined specifications. In addition to the factors already on the input file, PRTMOD makes available other data in the form of pseudo factors. These factors include module, task, and line sequence numbers, and the module and task title statements. Information concerning the use of these pseudo factors can be found later in this document.
The final report may be sorted on one or two of the data vectors contained on the input MODSET file. The task data may be presented in sorted sequence within each module if desired. The modules and tasks reported may be limited by specifying a print suppression condition for either type of data. Suppression of a module will prevent the printing of any of the tasks contained within it.
Program Invocation
The specific syntax for program invocation varies between operating systems. This document diplays the code for the AIX version.
opt: E Executive Summary Option, prints summary statistics of all
task factor values within each module.
I Print invalids as asterisks instead of blanks.
ssss: The study number
MS: Input MODSET file, required if module factor data is printed
FS: Input FACSET file, required if task factor data is printed
MT: Input Module Title file
CV1: Input MODSET Codes file. Required only if codes are required
for module factors.
CV2: Input FACSET Codes file. Required only if codes are required
for task factors.
PRTMOD Control Card
PRTMOD: cc 01-06 The literal 'PRTMOD' study: cc 08-11 The study number for this run nhead: cc 13 The number of column heading lines
Title Card (optional)
This card is not required. If used, the title supplied will be printed at the top of each page on the output report. If the title field of this card is blank or if this card is not used the title for the study found on the input file will be used and printed at the top of each page of the report.
TITLE: cc 01-05 The literal 'TITLE' title: cc 07-66 Any report title information desired
Footnote Card (optional)
This card is not required. If used, the footnote supplied will be printed on the last line of each page on the output report.
FOOT: cc 01-05 The literal 'FOOT' footnote: cc 06-77 Any information desired
Module Factor Requests
This set of cards specifies the module factor information to be printed on the generated report. If no printing of module factor data is desired, the PRTFAC program should be used instead.
Module Factors Control Card
The card controls the output of the module factor data. The data may be printed in module sequence, or sorted using module factors from the input MODSET file. A flag may also be set to control the sort order (ascending or descending). An optional field may also be used which allows the printing of modules to be suppressed. If used, all modules which have a value that meets the specified condition for the indicated factor will NOT be printed. If the line sequence number is printed on the report when this capability is used, the sequence numbers will be in order but not continuous. Also, any task factor data for a suppressed module will NOT be printed.
MOD: cc 01-03 The literal 'MOD' nmod: cc 05-07 The number of module factors to print. s1: cc 09-13 The factor ID for the primary sort. sq1: cc 15 The sort sequence for the primary sort. 'A' = Ascending, 'D' = Descending (default) s2: cc 17-21 The factor ID for the secondary sort. sq2: cc 23 The sort sequence for the secondary sort 'A' = Ascending, 'D' = Descending (default) fac: cc 25-29 The factor ID for print suppression. cond: cc 31-32 The suppression condition to be tested 'EQ', 'NE', 'LE', 'LT', 'GE' or 'GT' val: cc 34-43 The decimal number for the comparison.
Module Factor Request Cards
The cards in this section must contain factor identifiers for each factor to be printed on the output report. The specified order of the identifiers determines the sequence of the data columns on the output report. In addition to the factors available from the input file, several pseudo factors are available for use on the output report. The following table lists the different factor types which may be printed in the report.
Identifier Factor Description
---- Factors Available on Input file -----
Mxxxx MODSET Factor Identifier
---- Pseudo Factors within PRTMOD -----
L0000 Line sequence number for modules within report
T0000 Module sequence number
TITLE Module title statement
id1: cc 01-05 --+ id2: cc 07-11 : id3: cc 13-17 : id4: cc 19-23 : id5: cc 25-29 : id6: cc 31-35 : The next factor identifier id7: cc 37-41 +-- to be printed. Blank id8: cc 43-47 : fields will be ignored. id9: cc 49-53 : id10: cc 55-59 : id11: cc 61-65 : id12: cc 67-71 : id13: cc 63-77 --+
PRTMOD will continue reading factor request cards until it has found the number of factor identifiers specified on the Module Factors Control Card.
Task Factor Requests (optional)
This set of cards specifies the task factor information to be printed on the generated report. If no printing of task factor data is desired, this set of cards should not be included, and an Executive Summary Report will be produced.
Task Factors Control Card
The information specified on this card controls the output of the task factor data. The data may be printed in task sequence, or sorted using either one or two task factors from the input FACSET file. A flag may also be set to control the sort order (ascending or descending). An optional field may also be used which allows the printing of tasks to be suppressed. If used, all tasks which have a value that meets the specified condition for the indicated factor will NOT be printed. All other tasks will be printed. It should be noted that if the line sequence number is printed on the report when this capability is used, the sequence number will be in order, but it will not be continuous. For example, if five tasks were to be printed, but the third module was suppressed via this feature, the line sequence number progression would be 1, 2, 4, 5.
TSK: cc 01-03 The literal 'TSK' nfac: cc 05-07 The number of task factors to print. s1: cc 09-13 The task factor ID for the primary sort. sq1: cc 15 The sort sequence for the primary sort. 'A' = Ascending, 'D' = Descending (default) s2: cc 17-21 The task factor ID for the secondary sort sq2: cc 23 The sort sequence for the secondary sort. 'A' = Ascending, 'D' = Descending (default) fac: cc 25-29 The task factor ID to use for print suppression. cond: cc 31-32 The suppression condition to be tested 'EQ', 'NE', 'LE', 'LT', 'GE' or 'GT'val: cc 34-43 The decimal number to be used for the comparison.
Task Factor Request Cards
The cards in this section must contain factor identifiers for each factor to be printed on the output report. The specified order of the identifiers determines the sequence of the data columns on the output report. In addition to the factors available from the input file, several pseudo factors are available for use on the output report. The following table lists the different factor types which may be printed in the report.
Identifier Factor Description
---- Factors Available on Input file -----
Fxxxx FACSET Factor Identifier
---- Pseudo Factors within PRTMOD -----
L0000 Line sequence number for tasks within report
T0000 Task sequence number
TITLE Task title statement
id1: cc 01-05 --+
id2: cc 07-11 :
id3: cc 13-17 :
id4: cc 19-23 :
id5: cc 25-29 :
id6: cc 31-35 : The next factor identifier to
id7: cc 37-41 +-- be printed. Blank fields will
id8: cc 43-47 : be ignored.
id9: cc 49-53 :
id10: cc 55-59 :
id11: cc 61-65 :
id12: cc 67-71 :
id13: cc 63-77 --+
PRTMOD will continue reading factor request cards until it has found the number of factor identifiers specified on the Task Factors Control Card.
Report Format Specifications
This set of cards controls the appearance of the report printed by PRTMOD. These cards include the column headings for the report as well as any formatting information that is required for printing the data requested. In this section the user is asked to provide a sample of how the final report is to look. To insure an easily checked setup, the user is asked to set up the left half of the report page, then the right half of the report page. Each half-page set up will include the number of column heading cards specified on the PRTMOD Control Card above, as well as one or two additional cards showing where to place the data under the headings provided. The same number of column heading cards must be used for each half-page, even if this means including blank lines. The data format line or lines must also appear for each half-page even if this means including a blank line. The cards would be arranged in the following manner:
Column heading line 1 - Left Half Page Column heading line 2 - Left Half Page . . . Column heading line 9 - Left Half Page Module Data Format & Position- Left Half Page Task Data Format & Position- Left Half Page Column heading line 1 - Right Half Page Column heading line 2 - Right Half Page . . . Column heading line 9 - Right Half Page Module Data Format & Position- Right Half Page Task Data Format & Position- Right Half Page
As many as nine lines of column headings are acceptable and as few as zero will work. It is recommended however that at least 1 column heading card is used for labeling the output, and that column headings are limited to about four lines.
The following example demonstrates how the control cards give a preview of what the output report will look like. The third and sixth lines of the example contain the data formatting information for the output. The details of these lines will be described later in this section.
Half-Page Line Actual Image Left 1-> Sequence Learning Left 2-> Number Difficulty Title Left - Data 3-> T..............! Left - Data 4-> M... M...D. T..............! Right 5-> Average Percent Percent Members Right 6-> Time Spent Rating Right - Data 7-> Right - Data 8-> F...D.. F...D..
Please note the '!' character in the example. This character is called the LEFT-WIDTH delimiter. Its purpose is to signify the desired width of the LEFT Half. PRTMOD uses 132 characters from each pair of cards above to construct the report. The LEFT WIDTH delimiter can be used to break the information in a convenient place. For instance, if the LEFT WIDTH delimiter had not been used in the example, the break between Left and Right would have occurred at column 80 and that could be in the middle of the factor or title columns. This would complicate a proper setup of the column headings and data format cards. The LEFT WIDTH delimiter was created to permit the user to avoid this problem. It should be noted that the LEFT WIDTH delimiter should only be used once on any one of the Left Half cards. When encountered, the Left Half cards will include all information from the first card column up to but not including the column containing the LEFT WIDTH delimiter. The Right Half cards will then be read, and their data added to the Left Half cards to build a 132 character line. For example, if only 61 characters were used from the Left Half cards, the first 71 characters would be used from each of the Right Half cards to build the output report formatting and heading information.
The following three subsections describe the column heading, module, and task data format cards respectively. Remember that each card is part of a paired set and only half of the pair is described.
Column Heading Cards
The column heading cards may contain any information desired for labeling the output report. Any characters will be printed except for the '!' character, which is reserved as the LEFT WIDTH delimiter. The information on these cards will be printed darker on the output report than normal in order to highlight them as column headings. Two column heading parts will be joined together to form a 132 character line.
heading: cc 01-80 Any column heading information desired for half of the page.
Module Data Format Cards
This pair of cards is always required by PRTMOD. The information described on them tells PRTMOD how the module factors are to be printed on the output report. Each factor specified on the module factor request cards must have a corresponding format description on this pair of cards or the program will terminate in error. The first format description encountered is matched with the first factor request, the second with the second request, and so on. When the format descriptions are matched with their corresponding factor request, the data type of each is compared. If the data types do not match an error has occurred. The factor request identifiers and their corresponding data type formats can be found in the table in the following paragraph. The following table contains a list of the acceptable format descriptions available for use in a PRTMOD run. These descriptions are flexible in that they allow the user to determine what form is desired for printing the factor data. Factors can be printed as floating point numbers with any decimal precision desired. Module titles may be printed in any size field specified. If the field is too small, the rightmost data will be chopped off. If it is too big, spaces will be added to the right to fill the field.
Factor Format Type Examples L0000 M M... M. M..... T0000 M M... M. M..... Mxxxx M M... M....D.. MD.... Mxxxx A (Code Value) A... A....... A..... TITLE T T... T........ T T.
In the examples above, the 'D' character signifies the position where a decimal point is to occur. If no D is specified for an "M" type factor, the decimal will not appear. Periods are used as data-width place holders in the format. This means that given the second example for factors (Mxxxx), the print field would be 8 characters wide with 2 digits of decimal accuracy. Any characters other than 'M' or 'T' (optionally followed by periods and/or a 'D') will be treated as literals and will be printed on the first line of each module in the report. When code values are requested for "M" type factors, the values will be rounded to integers before looking up the code values.
data format: cc 01-80 Data type, width and position for each factor printed on this half page.
Task Data Format Cards (optional)
This pair of cards is required if a set of task factors requests were given as described in the previous section. The information described on them tells PRTMOD how the task factors are to be printed on the output report. Each factor specified on the task factor request cards must have a corresponding format description on this pair of cards or the program will terminate in error. The first format description encountered is matched with the first factor request, the second with the second request, and so on. When the format descriptions are matched with their corresponding factor request, the data type of each is compared. If the data types do not match an error has occurred. The factor request identifiers and their corresponding data type formats can be found in the table in the following paragraph. The following table contains a list of the acceptable format descriptions available for use in a PRTMOD run. These descriptions are flexible in that they allow the user to determine what form is desired for printing the factor data. Factors can be printed as floating point numbers with any decimal precision desired. Task titles may be printed in any size field specified. The title will be truncated or padded with spaces to fit in the space provided.
Factor Format Type Examples
L0000 F F... F. F.....
T0000 F F... F. F.....
Fxxxx F F... F..D. FD.. F..D
A (Code) A... A....... A.....
S (Cumulative) S... S...D. S...D...
TITLE T T... T........ T T.
In the examples above, the 'D' character signifies the position where a decimal point is to occur. If no D is specified for an "F" type factor, the decimal will not appear. Periods are used as data-width place holders in the format. This means that given the second example for factors (Fxxxx), the print field would be 8 characters wide with 2 digits of decimal accuracy. Any characters other than 'F' or 'T' (optionally followed by periods and/or a 'D') will be treated as literals and will be printed on the first line of each task in the report. When code values are requested for "F" type factors, the values will be rounded to integers before looking up the code values.
data format: cc 01-80 Data type, width and position for each factor printed on this half page.
Report Note Cards (optional)
The cards in this section are textual notes that are to be printed on the report.
note: cc 01-80 Any text desired
These cards are terminated by an end-of-file or an '@eof' image.
@codap prtmod - ssss ms000 - mt000
PRTMOD ssss 3
TITLE Test run of PRTMOD, sorted executive summary
MOD 7 M0005 A M0004 D
TITLE M0008 M0023 M0015 M0004 M0022 L0000
Module Predicted!
Learning Learning
Statement Difficulty Difficulty
T............................... M...D.. M...D..
Percent Consequences Module Line
Members of Inadequate Delay Sequence
Performing Performance Tolerance Number
M...D.. M....D. M...D.. M.....
This run of PRTMOD will print the requested factors for the
modules on the specified Module Title File as an Executive Summary.
@EOF