Differences between revisions 3 and 4
Revision 3 as of 2019-04-01 13:27:09
Size: 5184
Editor: JanErik
Comment: Changed how ET-only animals are represented
Revision 4 as of 2019-04-04 12:26:05
Size: 5175
Editor: Valentina
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= READ ME File Performance XML =
Line 4: Line 5:
The XML file format used for performance data contains three distinct sections called
'''traits''', '''animals''' and '''officials''' respectively.
The XML file format used for performance data contains three distinct sections called '''traits''', '''animals''' and '''officials''' respectively.
Line 7: Line 7:
The '''traits''' section corresponds roughly to the previous parameter file (i.e. 603
format), the '''animals''' section contains the data from the previous performance
file plus the data in the ET file (i.e. 602 + 604 format) and, finally, the
'''officials''' section contains the data from the direct file plus the data from the
maternal file (i.e. 605 format).
The '''traits''' section corresponds roughly to the previous parameter file (i.e. 603 format), the '''animals''' section contains the data from the previous performance file plus the data in the ET file (i.e. 602 + 604 format) and, finally, the '''officials''' section contains the data from the direct file plus the data from the maternal file (i.e. 605 format).
Line 14: Line 10:
The traits section consists of a sequence of trait definition nodes.
Each of those trait definition nodes has a header (the XML node) that defines the
default values for some attributes of the trait (those attributes not usually
specified per animal, i.e `TYPE`, `EBREED`, `RCOU`, `mpe`, etc) and a unique identifier to
be able to refer to this trait definition from the animals (in attribute `IDX`).
The trait definition node contains a sequence of nodes namned "e" (short for
environment effect) that defines `ETYPE`, `COL` and `VALUETYPE` for each environment
effect that the trait consists of.
The `ETYPE` attribute has to have a value of "R", "F" or "X" corresponding to
random, fixed and covariate effects respectively.
The `COL` attribute is the "name" of the effect and the `VALUETYPE` attribute
specifies the type of the values for this effect.
The traits section consists of a sequence of trait definition nodes. Each of those trait definition nodes has a header (the XML node) that defines the default values for some attributes of the trait (those attributes not usually specified per animal, i.e `TYPE`, `EBREED`, `RCOU`, `mpe`, etc) and a unique identifier to be able to refer to this trait definition from the animals (in attribute `IDX`). The trait definition node contains a sequence of nodes namned "e" (short for environment effect) that defines `ETYPE`, `COL` and `VALUETYPE` for each environment effect that the trait consists of. The `ETYPE` attribute has to have a value of "R", "F" or "X" corresponding to random, fixed and covariate effects respectively. The `COL` attribute is the "name" of the effect and the `VALUETYPE` attribute specifies the type of the values for this effect.
Line 28: Line 13:
The animals section consists of a sequence of nodes named "a" (short for animal)
that have a header containing attributes `id` (for the AID), `twin` (for the TWIN
value of this animal) and `et` (for the ET value of this animal).
Each of the animal nodes contain a sequence of trait reference nodes (also
called trait like the trait definition nodes).
These trait reference nodes has a header containing attributes like `herid`,
`status` and `dep`, but also the `IDX` attribute that explicitly references the
trait definition with the same IDX attribute.
Trait reference nodes contain a sequence of "e" nodes corresponding to the
similar sequence of "e" nodes defined in the referenced (via the IDX attribute)
trait definition.
These "e" nodes simply contain the value of the environment effect with a
ETYPE/COL/VALUETYPE of the "e" node in the corresponding position in the trait
definition.
The animals section consists of a sequence of nodes named "a" (short for animal) that have a header containing attributes `id` (for the AID), `twin` (for the TWIN value of this animal) and `et` (for the ET value of this animal). Each of the animal nodes contain a sequence of trait reference nodes (also called trait like the trait definition nodes). These trait reference nodes has a header containing attributes like `herid`, `status` and `dep`, but also the `IDX` attribute that explicitly references the trait definition with the same IDX attribute. Trait reference nodes contain a sequence of "e" nodes corresponding to the similar sequence of "e" nodes defined in the referenced (via the IDX attribute) trait definition. These "e" nodes simply contain the value of the environment effect with a ETYPE/COL/VALUETYPE of the "e" node in the corresponding position in the trait definition.
Line 43: Line 15:
The special situation when an animal have no associated performance data, only
ET status, is handled by having an "a" node without any contained trait
reference nodes (i.e. only the header) and also without the `twin` attribute.
The special situation when an animal have no associated performance data, only ET status, is handled by having an "a" node without any contained trait reference nodes (i.e. only the header) and also without the `twin` attribute.
Line 49: Line 19:
Line 76: Line 47:
In the above example, we can see a trait definition with IDX "aww1" that is of `TYPE` aww, `EBREED` LIM, etc that have four environment effects HYS/ASEXTWIN/AACA/YEAR.
Line 77: Line 49:
In the above example, we can see a trait definition with IDX "aww1" that is of
`TYPE` aww, `EBREED` LIM, etc that have four environment effects HYS/ASEXTWIN/AACA/YEAR.

In the animals section, the first animal (LIMCZEM000555163042) has a trait
reference to that definition with herid, status and dep specified and the
corresponding environment effects values 0/1/3/2012.
The second animal (LIMCZEM000575463149) demonstrates the special situation when
an animal have ET status, but no performance data.
In the animals section, the first animal (LIMCZEM000555163042) has a trait reference to that definition with herid, status and dep specified and the corresponding environment effects values 0/1/3/2012. The second animal (LIMCZEM000575463149) demonstrates the special situation when an animal have ET status, but no performance data.
Line 87: Line 52:
The third section, officials, has a structure very similar to the animals
section in that it contains a sequence of animals nodes, each containing a
sequence of trait reference nodes.
The difference is that these trait reference nodes only contain the three
attributes `status`, `Drel` and `Mrel`.
The example above is continued with:
The third section, officials, has a structure very similar to the animals section in that it contains a sequence of animals nodes, each containing a sequence of trait reference nodes. The difference is that these trait reference nodes only contain the three attributes `status`, `Drel` and `Mrel`. The example above is continued with:
Line 102: Line 63:

As you can see from the above example, the value of `status` for trait aww1 and
animal LIMCZEM000555163042 is specified twice, in both the animals section and the officials section,
so in this case the values must be identical.
As you can see from the above example, the value of `status` for trait aww1 and animal LIMCZEM000555163042 is specified twice, in both the animals section and the officials section, so in this case the values must be identical.

READ ME File Performance XML

The XML File Format Used for Performance Data

The XML file format used for performance data contains three distinct sections called traits, animals and officials respectively.

The traits section corresponds roughly to the previous parameter file (i.e. 603 format), the animals section contains the data from the previous performance file plus the data in the ET file (i.e. 602 + 604 format) and, finally, the officials section contains the data from the direct file plus the data from the maternal file (i.e. 605 format).

The Traits Section

The traits section consists of a sequence of trait definition nodes. Each of those trait definition nodes has a header (the XML node) that defines the default values for some attributes of the trait (those attributes not usually specified per animal, i.e TYPE, EBREED, RCOU, mpe, etc) and a unique identifier to be able to refer to this trait definition from the animals (in attribute IDX). The trait definition node contains a sequence of nodes namned "e" (short for environment effect) that defines ETYPE, COL and VALUETYPE for each environment effect that the trait consists of. The ETYPE attribute has to have a value of "R", "F" or "X" corresponding to random, fixed and covariate effects respectively. The COL attribute is the "name" of the effect and the VALUETYPE attribute specifies the type of the values for this effect.

The Animals Section

The animals section consists of a sequence of nodes named "a" (short for animal) that have a header containing attributes id (for the AID), twin (for the TWIN value of this animal) and et (for the ET value of this animal). Each of the animal nodes contain a sequence of trait reference nodes (also called trait like the trait definition nodes). These trait reference nodes has a header containing attributes like herid, status and dep, but also the IDX attribute that explicitly references the trait definition with the same IDX attribute. Trait reference nodes contain a sequence of "e" nodes corresponding to the similar sequence of "e" nodes defined in the referenced (via the IDX attribute) trait definition. These "e" nodes simply contain the value of the environment effect with a ETYPE/COL/VALUETYPE of the "e" node in the corresponding position in the trait definition.

The special situation when an animal have no associated performance data, only ET status, is handled by having an "a" node without any contained trait reference nodes (i.e. only the header) and also without the twin attribute.

Example

The above description is perhaps made clearer by using a minimal example:

<interbull type="performance" subtype="interbeef" version="1.0">
  <traits>
    <trait TYPE="aww" EBREED="LIM" RCOU="CZE" ref="210" h2="11" cgn="1"
           twin="N" dam="Y" mpe="Y" pev="N" IDX="aww1">
      <e ETYPE="R" COL="HYS" VALUETYPE="Int"/>
      <e ETYPE="F" COL="ASEXTWIN" VALUETYPE="Int"/>
      <e ETYPE="F" COL="AACA" VALUETYPE="Int"/>
      <e ETYPE="F" COL="YEAR" VALUETYPE="Int"/>
    </trait>
  </traits>

  <animals>
    <a id="LIMCZEM000555163042" twin="1" et="0">
      <trait herid="CZE004200053400" status="05" dep="279.0" IDX="aww1">
        <e>0</e>
        <e>1</e>
        <e>3</e>
        <e>2012</e>
      </trait>
    </a>
    <a id="LIMCZEM000575463149" et="1">
      <is-et/>
    </a>
  </animals>
  ...

In the above example, we can see a trait definition with IDX "aww1" that is of TYPE aww, EBREED LIM, etc that have four environment effects HYS/ASEXTWIN/AACA/YEAR.

In the animals section, the first animal (LIMCZEM000555163042) has a trait reference to that definition with herid, status and dep specified and the corresponding environment effects values 0/1/3/2012. The second animal (LIMCZEM000575463149) demonstrates the special situation when an animal have ET status, but no performance data.

The Officials Section

The third section, officials, has a structure very similar to the animals section in that it contains a sequence of animals nodes, each containing a sequence of trait reference nodes. The difference is that these trait reference nodes only contain the three attributes status, Drel and Mrel. The example above is continued with:

  ...
  <officials>
    <a id="LIMCZEM000555163042">
      <trait status="05" Drel="35" Mrel="35" IDX="aww1"/>
    </a>
  </officials>
</interbull>

As you can see from the above example, the value of status for trait aww1 and animal LIMCZEM000555163042 is specified twice, in both the animals section and the officials section, so in this case the values must be identical.

Final Remarks

  • The calving traits have an almost identical structure, the only real difference is the TYPE and IDX attribute values.

  • The above description of the structure of the XML file for performance data is valid for spring/summer of 2019, but we already know that changes will need to be introduced after that (i.e. for 1910t).

public/FilePerformanceXML (last edited 2019-09-16 09:39:12 by JanErik)