summary.ped_stats {pedtricks}R Documentation

Post-processes output from ped_stats

Description

Generates a manageable summary of pedigree-wide statistics reported by ped_stats, either for a single pedigree or for a comparison between pedigrees

Usage

## S3 method for class 'ped_stats'
summary(object, ...)

Arguments

object

An object of class ped_stats generated by ped_stats

...

extra arguments

Value

Returns a table of numbers of records, maternities, paternities, pairwise sibship relationships, numbers of different classes of grand-parental relationships, pedigree depth, number of founders, mean sibship sizes, simple statistics of numbers of inbred and non-inbred individuals, and proportions of pairwise relationship coefficients equal to or greater than several thresholds.


[Package pedtricks version 0.4.2 Index]