summary.IBDprob: Summary function for objects of class IBDprob

In statgenIBD: Calculation of IBD Probabilities

Summary function for objects of class IBDprob

Description

Prints a short summary for objects of class IBDprob. The summary consists of the population type, number of evaluation points, number of individuals and names of the parents in the object.

Usage

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

Arguments

object	An object of class IBDprob.
...	Not used.

Value

No return value, a summary is printed.

Examples

## Compute IBD probabilities for Steptoe Morex.
SxMIBD <- calcIBD(popType = "DH",
                  markerFile = system.file("extdata/SxM", "SxM_geno.txt",
                                          package = "statgenIBD"),
                  mapFile = system.file("extdata/SxM", "SxM_map.txt",
                                        package = "statgenIBD"))

## Print summary
summary(SxMIBD)

statgenIBD documentation built on May 29, 2024, 1:32 a.m.