summary_pedmat: Summary Statistics for Pedigree Matrices
In visPedigree: Tidying, Analysis, and Fast Visualization of Animal and Plant Pedigrees
summary_pedmat R Documentation
Summary Statistics for Pedigree Matrices
Description
Computes and displays summary statistics for a pedmat object.
Usage
summary_pedmat(x)
Arguments
x
A pedmat object from pedmat.
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.
Value
An object of class "summary.pedmat" with statistics including
method, dimensions, compression ratio (if compact), mean relationship,
and matrix density.
See Also
pedmat
Examples
tped <- tidyped(small_ped)
A <- pedmat(tped, method = "A")
summary_pedmat(A)
visPedigree documentation built on March 30, 2026, 9:07 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| summary_pedmat | R Documentation |
Summary Statistics for Pedigree Matrices
Description
Computes and displays summary statistics for a pedmat object.
Usage
summary_pedmat(x)
Arguments
x |
A pedmat object from |
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.
Value
An object of class "summary.pedmat" with statistics including
method, dimensions, compression ratio (if compact), mean relationship,
and matrix density.
See Also
pedmat
Examples
tped <- tidyped(small_ped)
A <- pedmat(tped, method = "A")
summary_pedmat(A)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.