Differences between revisions 4 and 5
Revision 4 as of 2013-01-28 16:42:46
Size: 1900
Editor: João
Comment:
Revision 5 as of 2013-01-28 21:05:56
Size: 1814
Editor: mtl-93-187-66-202
Comment:
Deletions are marked like this. Additions are marked like this.
Line 7: Line 7:
 . For information about installation and sample data for testing the program, see [[public/GEBVtest_software]].
Line 9: Line 9:
----------
 
. usage: gebvtest.py [-h] [-v] [-m] [-M MERGEDIR] [-Z] [-C] brd pop datadir positional arguments:
  . brd evaluation breed code (BSW/GUE/JER/HOL/RDC/SIM) pop population code (same as country code except for
   . CHR/DEA/DFS/FRR/FRM)
=== Running the program ===
The program should be run from within the '''''programs''''' directory
. Typing

'''python gebvtest.py --help'''

will give a summary of the program usage:

{{{
usage: gebvtest.py [-h] [-v] [-m] [-M MERGEDIR] [-Z] [-C] brd pop datadir

positional arguments:
  brd evaluation breed code (BSW/GUE/JER/HOL/RDC/SIM)
 
pop population code (same as country code except for
                        CHR/DEA/DFS/FRR/FRM)
Line 14: Line 24:
 optional arguments:
  . -h, --help show this help message and exit -v, --verbose increase output verbosity -m, --mergefiles write merged data files (for independent data checks) -M MERGEDIR, --mergedir MERGEDIR
   . absolute or relative path for merged data files (default=DATADIR/merged)

optional arguments:
  -h, --help show this help message and exit
 
-v, --verbose increase output verbosity
 
-m, --mergefiles write merged data files (for independent data checks)
 
-M MERGEDIR, --mergedir MERGEDIR
                        absolute or relative path for merged data files
                       
(default=DATADIR/merged)
Line 18: Line 33:
   . or usage at ITBC)                         or usage at ITBC)
Line 20: Line 35:
 See detailed instructions at:
 https://wiki.interbull.org/gebvtest_instructions?action=print

----------
=== Sample data for program testing ===
Some sample data for breed HOL and country ABC are available in the `sample_data` directory. The two programs can be run from the `programs` directory as follows:

 . python gtconvert.py -v hol abc ../sample_data python gebvtest.py -v -m hol abc ../sample_data

The outputs should match those in the source zip file.
}}}

Program gebvtest.py - User Manual

UNDER CONSTRUCTION!

Information about the program:

The program gebvtest.py performs the GEBV validation tests for one breed-population combination, for all traits. At the end of the program a zip file is created with the input files and the result file, ready for submission to the ITBC. The ITBC will perform some additional data checks and re-run the program to check the results. The result file is a new file735 format file, which is a modification and extension of the previous file731 format file.

For information about installation and sample data for testing the program, see public/GEBVtest_software.

Running the program

The program should be run from within the programs directory. Typing

python gebvtest.py --help

will give a summary of the program usage:

usage: gebvtest.py [-h] [-v] [-m] [-M MERGEDIR] [-Z] [-C] brd pop datadir

positional arguments:
  brd                   evaluation breed code (BSW/GUE/JER/HOL/RDC/SIM)
  pop                   population code (same as country code except for
                        CHR/DEA/DFS/FRR/FRM)
  datadir               absolute or relative path to data files

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         increase output verbosity
  -m, --mergefiles      write merged data files (for independent data checks)
  -M MERGEDIR, --mergedir MERGEDIR
                        absolute or relative path for merged data files
                        (default=DATADIR/merged)
  -Z, --no-zip          do not create a zip file (eg. for preliminary testing
                        or usage at ITBC)
  -C, --cleanup         delete all files successfully added to the zip file

public/gebvtest_py (last edited 2015-03-10 22:44:09 by nilforo)