summary.simfam_tvc: Summary method for 'simfam_tvc'

In FamEvent: Family Age-at-Onset Data Simulation and Penetrance Estimation

Summary method for simfam_tvc

Description

Provides a summary of simulated data.

Usage

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

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.

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.

Author(s)

Yun-Hee Choi

See Also

simfam_tvc

Examples

set.seed(4321)
fam <- simfam_tvc(N.fam = 10, design = "pop", variation = "frailty", 
       base.dist = "Weibull", frailty.dist = "gamma", depend = 1, 
       add.tvc = TRUE, tvc.type = "CO", tvc.range = c(30,60), 
       tvc.parms = c(1, 0.1, 0), allelefreq = 0.02, 
       base.parms = c(0.01, 3), vbeta = c(-1.13, 2.35))

summary(fam)
## Not run: 
Study design:           pop: population-based study with affected probands 
Baseline distribution:  Weibull 
Frailty distribution:   gamma 
Number of families:                     10 
Average number of affected per family:  3.1 
Average number of carriers per family:  3.4 
Average family size:                    16.3 
Average age of onset for affected:      48.19 
Average number of TVC event per family: 4 

## End(Not run)

FamEvent documentation built on July 3, 2024, 5:07 p.m.