6.3 The PedigreeMetadata Class

The PedigreeMetadata class stores metadata about pedigrees. This helps improve performance in some procedures, and also makes it easy to access useful summary data. Metadata are collected when the pedigree is loaded and accessed by many PyPedal routines.

Attributes of PedigreeMetadata objects. Attribute & Default & Description

$\begin{xtabular}{l\vert l\vert p{4in}} name & \texttt{pedname} & Name assigned ... ...erd_list & $[]$\ & List of the unique herds in the pedigree. \\ \end{xtabular}$

Metadata are gathered furing the pedigree loading process, but after load-time renumbering has occured (if requested). When a pedigree is renumbered after it has been loaded the unique sire, dam, and founders lists are not updated to contain the renumbere IDs. The metadata may be updated by instantiating a new PedigreeMetadata object and using it to replace the original metadata:

example.metadata = PedigreeMetadata(example.pedigree,example.kw)

Alternatively, ID maps (Section 7.2) may be used to produce expected lists of animals.

The methods of PedigreeMetadata objects are listed in Table 6.10. The couting methods (nud, nuf, etc.) return two values each, a count and a list, and new couting methods may easily be added.

Methods of PedigreeMetadata objects. Method & Description

$\begin{xtabular}{l\vert p{4in}} \_\_init\_\_ & Initializes and returns a \class... ...a stored in the \class{PedigreeMetadata} object as a string. \\ \end{xtabular}$

See About this document... for information on suggesting changes.