PyPedal::pyp_newclasses::PedigreeMetadata Class Reference

The PedigreeMetadata() class stores metadata about pedigrees. More...

List of all members.

Public Member Functions

def __init__
 __init__() initializes a PedigreeMetadata object.
def printme
 printme() prints a summary of the metadata stored in the Pedigree() object.
def stringme
 stringme() returns a summary of the metadata stored in the pedigree as a string.
def fileme
 fileme() writes the metada stored in the Pedigree() object to disc.
def nus
 nus() returns the number of unique sires in the pedigree along with a list of the sires
def nud
 nud() returns the number of unique dams in the pedigree along with a list of the dams
def nug
 nug() returns the number of unique generations in the pedigree along with a list of the generations
def nuy
 nuy() returns the number of unique birthyears in the pedigree along with a list of the birthyears
def nuf
 nuf() returns the number of unique founders in the pedigree along with a list of the founders
def nuherds
 nuherds() returns the number of unique herds in the pedigree along with a list of the herds.

Public Attributes

 kw
 name
 filename
 myped
 pedcode
 num_records
 unique_sire_list
 unique_dam_list
 renumbered
 unique_gen_list
 unique_year_list
 unique_founder_list
 unique_herd_list


Detailed Description

The PedigreeMetadata() class stores metadata about pedigrees.

Hopefully this will help improve performance in some procedures, as well as provide some useful summary data.

A class to hold metadata about pedigrees.  Hopefully this will help improve performance in some procedures, as well as
provide some useful summary data.

Definition at line 2272 of file pyp_newclasses.py.


Member Function Documentation

def PyPedal::pyp_newclasses::PedigreeMetadata::__init__ (   self,
  myped,
  kw 
)

__init__() initializes a PedigreeMetadata object.

Parameters:
self Reference to the current Pedigree() object
myped A PyPedal pedigree.
kw A dictionary of options.
Returns:
An instance of a Pedigree() object populated with data object
Initialize a pedigree record.

Definition at line 2282 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::printme (   self  ) 

printme() prints a summary of the metadata stored in the Pedigree() object.

Parameters:
self Reference to the current Pedigree() object
Print the pedigree metadata.

Definition at line 2331 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::stringme (   self  ) 

stringme() returns a summary of the metadata stored in the pedigree as a string.

Parameters:
self Reference to the current Pedigree() object
Build a string from the pedigree metadata.

Definition at line 2361 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::fileme (   self  ) 

fileme() writes the metada stored in the Pedigree() object to disc.

Parameters:
self Reference to the current Pedigree() object
Save the pedigree metadata to a file.

Definition at line 2379 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::nus (   self  ) 

nus() returns the number of unique sires in the pedigree along with a list of the sires

Parameters:
self Reference to the current Pedigree() object
Returns:
The number of unique sires in the pedigree and a list of those sires integer-and-list
Count the number of unique sire IDs in the pedigree.  Returns an integer count
and a Python list of the unique sire IDs.

Definition at line 2411 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::nud (   self  ) 

nud() returns the number of unique dams in the pedigree along with a list of the dams

Parameters:
self Reference to the current Pedigree() object
Returns:
The number of unique dams in the pedigree and a list of those dams integer-and-list
Count the number of unique dam IDs in the pedigree.  Returns an integer count
and a Python list of the unique dam IDs.

Definition at line 2423 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::nug (   self  ) 

nug() returns the number of unique generations in the pedigree along with a list of the generations

Parameters:
self Reference to the current Pedigree() object
Returns:
The number of unique generations in the pedigree and a list of those generations integer-and-list
Count the number of unique generations in the pedigree.  Returns an integer
count and a Python list of the unique generations.

Definition at line 2436 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::nuy (   self  ) 

nuy() returns the number of unique birthyears in the pedigree along with a list of the birthyears

Parameters:
self Reference to the current Pedigree() object
Returns:
The number of unique birthyears in the pedigree and a list of those birthyears integer-and-list
Count the number of unique birth years in the pedigree.  Returns an integer
count and a Python list of the unique birth years.

Definition at line 2451 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::nuf (   self  ) 

nuf() returns the number of unique founders in the pedigree along with a list of the founders

Parameters:
self Reference to the current Pedigree() object
Returns:
The number of unique founders in the pedigree and a list of those founders integer-and-list
Count the number of unique founders in the pedigree.

Definition at line 2463 of file pyp_newclasses.py.

def PyPedal::pyp_newclasses::PedigreeMetadata::nuherds (   self  ) 

nuherds() returns the number of unique herds in the pedigree along with a list of the herds.

Parameters:
self Reference to the current Pedigree() object
Returns:
The number of unique herds in the pedigree and a list of those herds integer-and-list
Count the number of unique herds in the pedigree.

Definition at line 2480 of file pyp_newclasses.py.


The documentation for this class was generated from the following file:

Generated on Thu May 1 12:33:45 2008 for PyPedal by  doxygen 1.5.5