summary.simfam: Summary method for 'simfam'

Description Usage Arguments Value Author(s) See Also Examples

View source: R/summary.simfam.R

Description

Provides a summary of simulated data.

Usage

1
2
## S3 method for class '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.

Author(s)

Yun-Hee Choi

See Also

simfam

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
fam <- simfam(N.fam=100, design="pop", variation="frailty", depend=1,
       frailty.dist="gamma", 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 
Frailty distribution:                   gamma 
Number of families:                     100 
Average number of affected per family:  1.28 
Average number of carriers per family:  2.3 
Average family size:                    16.02 
Average age of onset for affected:      39.73 
Sampling weights used:                  1

## End(Not run)

FamEvent documentation built on May 20, 2017, 5:39 a.m.

Search within the FamEvent package
Search all R packages, documentation and source code