Printing test results files

NAME

ResPrint - print test results.

SYNOPSIS

ResPrint [-f options_file] [-o output_file]
  [-fields list_of_fieldIDs] [-items list_of_itemIDs]
  [-sessions list_of_sessionIDs] [-subjects list_of_subjectIDs]
  file ...
      

DESCRIPTION

The ResPrint tool converts the serialized the result files created by the gpRunTest tool to easier human/computer readable text files.

ResPrint takes as arguments the file names of the serialized results files, reads them in and prints out the information in tabulated text format. When ResPrint starts, it first loads GP system's default result output options file. Then it looks for the 'results.properties' output options file in the current directory and if found, loads it (see also section files).

Command line options can be used to select some of the test items to print. Also an options file can be given that can be used to configure the output.

-f options_file (optional)

Set the test configuration file where to read result printing options. This should be the first option to the ResPrint program. Options included in this file override the corresponding options given in the default and/or the current directory's options file.

-fields list_of_fieldIDs (optional)

Select which fields to output and the order of the fields. This option overrides the ResPrint's default list of fields or the result options file's list of fields.

-o output_file (optional)

The file where to write the results. If omitted, results are printed on standard output.

file ... (required)

Select which results files to process.

Some options can be used to filter the output of results. You can filter by item ID, session ID or subject ID:

-items list_of_itemIDs (optional)

Only print results for specified items. The list_of_itemIDs is a comma-separated list of test item IDs to include in output. If this option is not used, results for all items will be included.

-sessions list_of_sessionIDs (optional)

Only print results for specified sessions. The list_of_sessionIDs is a comma-separated list of test session IDs to include in output. If this option is not used, results for all sessions will be included.

-subjects list_of_subjectIDs (optional)

Only print results for specified subjects. The list_of_subjectIDs is a comma-separated list of subject IDs to include in output. If this option is not used, results for all subjects will be included.

If several filters are specified, the intersection of the item sets produced by the separate filters are included for output.

FILES

The ResPrint tool reads the serialized results files that are output as the result of running a test. They are by default written to files with the form of 'results_SESSIONID.ser' where the SESSIONID is the session ID of the session.

Output files: The tool converts the serialized results files to TAB-delimeted text format and outputs it to stardard output. You can save the results to a file by redirecting the output of the tool to a file. In the output, results are output one line per test item with item's parameters and answers as fields. Fields are separated by a ASCII TAB character. Comment lines may be output, they always begin with the hash ('#') character.

Result printing options files: The default printing options are first automatically loaded from GP systems default results options file '/usr/GuineaPig/lib/results.parameters'. Then, if a file named 'results.properties' is found in the current directory, it is loaded. Options found in that file override the corresponding options in the default options. Then if an additional option file is provided with the -f option, it is loaded.

The format of the options file(s) is described here.

EXAMPLES

First go to the test directory where the result files are kept. Then run the converter program and give the file names of the session result files as agruments, for example:

    ResPrint results_*

if your result file names begin with 'results_'. The converter then scans in the files given as arguments and prints out the results in a tabulated table. If you have the result printing options file 'results.properties' in the same directory, it is loaded automatically.

To use an additional or alternate options file you want to use, give its name with the -f option, for example:

    ResPrint -f results-alt.properties results_*

where the 'results-alt.properties' is the name of the additional options file.

To print only the item ID, the parameters 'A' and 'B' and the answer for question 'q1' (such as in example for A/B test in demos):

    ResPrint -fields ITEMID,A,B,q1 results_*

To print only results given for items with IDs 'item01', 'item04' and 'item22':

    ResPrint -items item01,item04,item22 results_*

To print the the same items above, but only those during sessions 'SES04', 'SES05' and 'SES06':

    ResPrint -items item01,item04,item22 -sessions SES04,SES05,SES06 results_*

Note that you can put those filters in an additional options file and read them with the -f option.

SEE ALSO

Tests, results processing

NOTES