summary.simfam

Provides a summary of simulated data.

 summary

Simulates age-at-onset traits associated with a segregating major gene in family data
obtained from population-based, clinic-based, or multi-stage designs. Appropriate ascertainment
correction is utilized to estimate age-dependent penetrance functions either parametrically from
the fitted model or nonparametrically from the data. The Expectation and Maximization algorithm
can infer missing genotypes and carrier probabilities estimated from family's genotype and
phenotype information or from a fitted model. Plot functions include pedigrees of simulated
families and predicted penetrance curves based on specified parameter values.
For more information see Choi, Y.-H., Briollais, L., He, W. and Kopciuk, K. (2021) FamEvent: An
R Package for Generating and Modeling Time-to-Event Data in Family Designs,
Journal of Statistical Software 97 (7), 1-30.

YunHee Choi

FamEvent

Family Age-at-Onset Data Simulation and Penetrance Estimation

summary.simfam function

<dl> <dt>object</dt>
<dd>An object class of <code>'simfam'</code> generated from <code>simfam</code> function</dd> <dt>digits</dt>
<dd>Number of significant digits to use when printing.</dd> <dt>...</dt>
<dd>Further arguments passed to or from other methods.</dd></dl>

Arguments

Author

Summary method for simfam — summary.simfam

<dl>

 <dt>object</dt>
<dd>An object class of <code>'simfam'</code> generated from <code>simfam</code> function</dd>

 <dt>digits</dt>
<dd>Number of significant digits to use when printing.</dd>

 <dt>...</dt>
<dd>Further arguments passed to or from other methods.</dd>



</dl>

summary.simfam: Summary method for `simfam`

Description

Usage

Value

Arguments

Author

See Also