PyPedal::pyp_reports Namespace Reference


Functions

def meanMetricBy
def pdfMeanMetricBy
def pdfPedigreeMetadata
def pdf3GenPed


Function Documentation

def PyPedal::pyp_reports::meanMetricBy (   pedobj,
  metric = 'fa',
  byvar = 'by',
  createpdf = False,
  conn = False 
)

meanMetricBy() returns a dictionary of means keyed by levels of the 'byvar' that can be used to draw graphs or prepare reports of summary statistics.

Parameters:
pedobj A PyPedal pedigree object.
metric The variable to summarize on a BY variable.
byvar The variable on which to group the metric.
createpdf Flag indicating whether or not a PDF version of the report should be created.
Returns:
A dictionary containing means for the metric variable keyed to levels of the byvar. dictionary
meanMetricBy() returns a dictionary of means keyed by levels of the 'byvar' that
can be used to draw graphs or prepare reports of summary statistics.

Definition at line 55 of file pyp_reports.py.

def PyPedal::pyp_reports::pdf3GenPed (   animalID,
  pedobj,
  titlepage = 0,
  reporttitle = '',
  reportauthor = '',
  reportfile = '' 
)

pdf3GenPed() draws a three-generation pedigree for animal 'animalID'.

Parameters:
animalID An animal ID or list of animal IDs.
pedobj A PyPedal pedigree object.
titlepage Show (1) or hide (0) the title page.
reporttitle Title of report; if '', _pdfTitle is used.
reportauthor Author/preparer of report.
reportfile Optional name of file to which the report should be written.
Returns:
1 on success, 0 on failure integer
pdf3GenPed() draws a three-generation pedigree for animal 'animalID'.

Definition at line 270 of file pyp_reports.py.

def PyPedal::pyp_reports::pdfMeanMetricBy (   pedobj,
  results,
  titlepage = 0,
  reporttitle = '',
  reportauthor = '',
  reportfile = '' 
)

pdfMeanMetricBy() returns a dictionary of means keyed by levels of the 'byvar' that can be used to draw graphs or prepare reports of summary statistics.

Parameters:
pedobj A PyPedal pedigree object.
results A dictionary containing means for the metric variable keyed to levels of the byvar.
titlepage Show (1) or hide (0) the title page.
reporttitle Title of report; if '', _pdfTitle is used.
reportauthor Author/preparer of report.
reportfile Optional name of file to which the report should be written.
Returns:
1 on success, 0 on failure integer
pdfMeanMetricBy() returns a dictionary of means keyed by levels of the 'byvar' that
can be used to draw graphs or prepare reports of summary statistics.

Definition at line 114 of file pyp_reports.py.

def PyPedal::pyp_reports::pdfPedigreeMetadata (   pedobj,
  titlepage = 0,
  reporttitle = '',
  reportauthor = '',
  reportfile = '' 
)

pdfPedigreeMetadata() produces a report, in PDF format, of the metadata from the input pedigree. It is intended for use as a template for custom printed reports.

Parameters:
pedobj A PyPedal pedigree object.
titlepage Show (1) or hide (0) the title page.
reporttitle Title of report; if '', _pdfTitle is used.
reportauthor Author/preparer of report.
reportfile Optional name of file to which the report should be written.
Returns:
A 1 on success, 0 otherwise. integer
pdfPedigreeMetadata() produces a report, in PDF format, of the metadata from
the input pedigree.  It is intended for use as a template for custom printed
reports.

Definition at line 183 of file pyp_reports.py.


Generated on Fri Mar 28 14:34:59 2008 for PyPedal by  doxygen 1.5.3