PyPedal::pyp_newclasses Namespace Reference

Classes
class	NewPedigree
class	SimAnimal
class	NewAnimal
class	LightAnimal
class	PedigreeMetadata
class	NewAMatrix
class	PyPedalError
class	PyPedalPedigreeInputFileNameError
class	tail_recursive
Functions
def	loadPedigree

---

Function Documentation

def PyPedal::pyp_newclasses::loadPedigree	(		options = '',
			optionsfile = 'pypedal.ini',
			pedsource = 'file',
			pedgraph = 0,
			pedstream = ''
	)

loadPedigree() wraps pedigree creation and loading into a one-step process. If the user passes both a dictionary and a filename, the dictionary will be used instead of the filename unless the dictionary is empty.

Parameters:

	options	Dictionary of pedigree options.
	optionsfile	File from which pedigree options should be read.
	pedsource	Source of the pedigree ('file'|'graph'|'graphfile'|'db'|'gedcomfile'|'textstream').
	pedgraph	XDiGraph from which to load the pedigree.
	pedstream	String of tuples to unpack into a pedigree.

Returns:

An instance of a NewPedigree object on success, a 0 on failure. PyPedal pedigree object

loadPedigree() wraps pedigree creation and loading into a one-step
process.  If the user passes both a dictionary and a filename, the
dictionary will be used instead of the filename unless the dictionary
is empty.

Definition at line 2643 of file pyp_newclasses.py.

---