summary.simfam_cmp function

Summary method for simfam_cmp

Provides a summary of simulated data from simfam_cmp function.

## S3 method for class 'simfam_cmp'
summary(object, digits = max(3, getOption("digits") - 3), ...)

Arguments

• object: An object class of 'simfam' generated from simfam_cmp function
• digits: Number of significant digits to use when printing.
• ...: Further arguments passed to or from other methods.

Returns

Displays a summary of simulated data and returns the following values: - num.fam: Number of families simulated.

• avg.num.affected1: Average number of affected individuals by event 1 per family.

• avg.num.affected2: Average number of affected individuals by event 2 per family.

• avg.num.carriers: Average number of mutation carriers per family.

• avg.family.size: Average family size.

• ave.ageonset1: Average age of onset for affected individuals by event 1.

• ave.ageonset2: Average age of onset for affected individuals by event 2.

Author(s)

Yun-Hee Choi

See Also

simfam_cmp

Examples

set.seed(4321)
fam <- simfam_cmp(N.fam = 50, design = "pop+", variation = "none", 
        base.dist = "Weibull", 
        base.parms = list(c(0.01, 3), c(0.01, 3)), 
        vbeta = list(c(-1.13, 2.35), c(-1,2)))
       
summary(fam)
## Not run:

Study design:                           pop+ 
Baseline distribution for event 1:      Weibull 
Baseline distribution for event 2:      Weibull 
Number of families:                     50 
Average number of event 1 per family:   1.24 
Average number of event 2 per family:   0.7 
Average number of carriers per family:  5.54 
Average family size:                    15.58 
Average age of onset for event 1:       42.59 
Average age of onset for event 2:       43.72 
## End(Not run)