Differences between revisions 1 and 13 (spanning 12 versions)
Revision 1 as of 2013-01-28 16:32:14
Size: 35
Editor: João
Comment:
Revision 13 as of 2013-02-01 10:20:25
Size: 3034
Editor: João
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Program gebvtest.py - User Manual = Program gebvtest.py - User Manual =
=== 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 [[https://wiki.interbull.org/public/GEBVtest_software?action=print|GEBVtest_software]].

=== Input files (from gtconvert.py OR prepared by the organization): ===
 * '''''traits''''' - GEBV test options file(Format: [[https://wiki.interbull.org/public/GEBVtest_traits?action=print|traits]])
 * '''''file300Cf''''' - national official genetic evaluations written in trait-independent format (Format: [[https://wiki.interbull.org/public/File300?action=print|File300]])
 * '''''file300Df''''' - daughter deviation file written in trait-independent format
 * '''''file300Cr''''' - reduced conventional genetic evaluation file written in trait-independent format
 * '''''file300Gr''''' - reduced genomic evaluation file written in trait-independent format
 * '''''file736''''' - file with birth date and genotyping flag (Format: [[https://wiki.interbull.org/public/File736?action=print|File736]])

=== 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
}}}
=== Output files: ===
 * '''''file735''''' - results from the GEBV test for all traits tested ([[https://wiki.interbull.org/public/File735format?action=print|Format: File735]]) ([[https://wiki.interbull.org/public/File735?action=print|Example]])
 * '''''gebvtest_log''''' - summary of the calculations ([[https://wiki.interbull.org/public/gebvtest_log?action=print|Example]])

Program gebvtest.py - User Manual

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 GEBVtest_software.

Input files (from gtconvert.py OR prepared by the organization):

  • traits - GEBV test options file(Format: traits)

  • file300Cf - national official genetic evaluations written in trait-independent format (Format: File300)

  • file300Df - daughter deviation file written in trait-independent format

  • file300Cr - reduced conventional genetic evaluation file written in trait-independent format

  • file300Gr - reduced genomic evaluation file written in trait-independent format

  • file736 - file with birth date and genotyping flag (Format: File736)

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

Output files:

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