Summary of simulated data

Share:

Description

Summary method for simfam. Provides summaries of simulated data.

Usage

1
2
## S3 method for class 'simfam'
summary(object, ...)

Arguments

object

An object class of simfam generated from simfam function

...

Additional arguments

Value

It displays the following summary values:

design

Study Design.

numfam

Number of families simulated.

avgnumaffec

Average number of affected individuals per family.

avgnumcarr

Average number of mutation carriers per family.

avgfamsize

Average family size.

aveageonset

Average age of onset for affected individuals.

Author(s)

Yun-Hee Choi

See Also

simfam

Examples

1
2
3
4
5
fam <- simfam(N.fam=100, design="pop", variation="frailty", depend=1,
       frailty.dist="gamma", base.dist="Weibull", base.parms=c(0.01, 3), 
       vbeta=c(-1.13, 2.35))

summary(fam)