PyPedal::pyp_classes::Pedigree Class Reference

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

List of all members.

Public Member Functions

def __init__
 __init__() initializes a Pedigree metata 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

Public Attributes

 name
 filename
 myped
 pedcode
 num_records
 unique_sire_list
 unique_dam_list
 reordered
 renumbered
 unique_gen_list
 unique_year_list
 unique_founder_list


Detailed Description

The Pedigree() 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 199 of file pyp_classes.py.


Member Function Documentation

def PyPedal::pyp_classes::Pedigree::__init__ (   self,
  myped,
  inputfile,
  name,
  pedcode = 'asd',
  reord = 0,
  renum = 0,
  debug = 0 
)

__init__() initializes a Pedigree metata object.

Parameters:
self Reference to the current Pedigree() object
myped A PyPedal pedigree
inputfile The name of the file from which the pedigree was loaded
name The name assigned to the PyPedal pedigree
pedcode The format code for the PyPedal pedigree
reord Flag indicating whether or not the pedigree is reordered (0|1)
renum Flag indicating whether or not the pedigree is renumbered (0|1)
Returns:
An instance of a Pedigree() object populated with data object
Initialize a pedigree record.

Definition at line 213 of file pyp_classes.py.

def PyPedal::pyp_classes::Pedigree::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 259 of file pyp_classes.py.

def PyPedal::pyp_classes::Pedigree::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 273 of file pyp_classes.py.

def PyPedal::pyp_classes::Pedigree::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 288 of file pyp_classes.py.

def PyPedal::pyp_classes::Pedigree::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 327 of file pyp_classes.py.

def PyPedal::pyp_classes::Pedigree::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 344 of file pyp_classes.py.

def PyPedal::pyp_classes::Pedigree::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 361 of file pyp_classes.py.

def PyPedal::pyp_classes::Pedigree::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 376 of file pyp_classes.py.

def PyPedal::pyp_classes::Pedigree::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 392 of file pyp_classes.py.


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

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