summary.multic: Use print() on a multic object

In multic: Quantitative Linkage Analysis Tools using the Variance Components Approach

Description

Produces a summary of a fitted multic object.

Usage

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

Arguments

object	an object of class "multic", usually a result of a call to "multic".
...	further arguments passed to or from other methods. Currently ... only exists to pass 'R CMD check' tests.

Details

This is a method for the function summary() for objects inheriting from class multic. See "summary" for the general behavior of this function.

Value

a list is returned with the following components. <s-arg name="call"> as contained on object </s-arg> <s-arg name="max.lod.score"> maximum lod score from the multic object </s-arg> <s-arg name="max.lod.locus"> IBD file that corresponds to the maximum lod score </s-arg> <s-arg name="max.lod.centimorgan"> position where the maximum lod score was found </s-arg> <s-arg name="n"> default=5. Number of families to examine for the top families </s-arg> <s-arg name="top.n.families"> ids of the top n families as they contribute to the maximum lod score </s-arg> <s-arg name="centimorgan.close.to.peak"> The minimum and maximum positions (cM) that produced a lod score greater than the "maximum - 1" and are contiguous to max.lod.locus. </s-arg>

See Also

multic, multic.object

Examples

## Not run: summary(fit)

multic documentation built on Jan. 15, 2017, 9:30 a.m.