View source: R/summary.simfam.R
summary.simfam | R Documentation |
simfam
Provides a summary of simulated data.
## S3 method for class 'simfam'
summary(object, digits = max(3, getOption("digits") - 3), ...)
object |
An object class of |
digits |
Number of significant digits to use when printing. |
... |
Further arguments passed to or from other methods. |
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. |
Yun-Hee Choi
simfam
set.seed(4321)
fam <- simfam(N.fam = 50, design = "pop", variation = "none", base.dist = "Weibull",
base.parms = c(0.01, 3), vbeta = c(-1.13, 2.35))
summary(fam)
## Not run:
Study design: pop
Baseline distribution: Weibull
Number of families: 50
Average number of affected per family: 1.24
Average number of carriers per family: 1.3
Average family size: 17.02
Average age of onset for affected: 40.08
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.