FamEvent (version 2.1)

summary.simfam: Summary method for simfam

Description

Provides a summary of simulated data.

Usage

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

Arguments

object

An object class of 'simfam' generated from simfam 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.

See Also

simfam

Examples

# NOT RUN {
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 
Sampling weights used:                  1
# }
# NOT RUN {
# }