View source: R/summary.simfam2.R
summary.simfam2 | R Documentation |
simfam2
Provides a summary of simulated data.
## S3 method for class 'simfam2'
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
simfam2
set.seed(4321)
data <- simfam(N.fam = 10, design = "noasc", variation = "none",
base.dist = "Weibull", base.parms = c(0.016, 3), vbeta = c(1, 1))
IBDmatrix <- diag(1, dim(data)[1])
data <- data[ , c(1:7, 11, 14)]
fam2 <- simfam2(inputdata = data, IBD = IBDmatrix, design = "pop",
variation = c("kinship","IBD"), depend = c(1, 1),
base.dist = "Weibull", base.parms = c(0.016, 3),
var_names = c("gender", "mgene"), vbeta = c(1,1),
agemin=20)
summary(fam2)
## Not run:
Study design: pop
Baseline distribution: Weibull
Frailty distribution: lognormal with kinship and IBD matrices
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
Sampling weights used: 1
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.