Summary Statistics for Pedigree Matrices

Computes and displays summary statistics for a pedmat object.

Usage

summary_pedmat(x)

Arguments

x

A pedmat object from pedmat.

Value

An object of class "summary.pedmat" with statistics including method, dimensions, compression ratio (if compact), mean relationship, and matrix density.

Details

Since pedmat objects are often S4 sparse matrices with custom attributes, use this function instead of the generic summary() to ensure proper display of pedigree matrix statistics.

See also

pedmat

Examples

tped <- tidyped(small_ped)
A <- pedmat(tped, method = "A")
summary_pedmat(A)
#> Summary of Pedigree Matrix (A)
#> ========================================
#> Input Size:      28  individuals
#> Calculated Size: 28  individuals
#> 
#> Matrix Properties:
#> - Mean off-diagonal relationship:  NA 
#> - Density (non-zero): 54.08%
#> ========================================