Learn R Programming

FamEvent (version 3.2)

summary.simfam_tvc: Summary method for simfam_tvc

Description

Provides a summary of simulated data.

Usage

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

Value

Displays a summary of simulated data and returns the following values:

num.fam

Number of families simulated.

avg.num.affected

Average number of affected individuals per family.

avg.num.carriers

Average number of mutation carriers per family.

avg.family.size

Average family size.

ave.ageonset

Average age of onset for affected individuals.

ave.num.tvc

Average number of TVC events per family.

Arguments

object

An object class of 'simfam_tvc' generated from simfam_tvc function

digits

Number of significant digits to use when printing.

...

Further arguments passed to or from other methods.

Author

Yun-Hee Choi

See Also

simfam_tvc