fbatge: fbatge

Description Usage Arguments Details References Examples

View source: R/fbatgeInterface.R

Description

Family based test for gene-environment interaction utilizing arbitrary family structures and multiple affected offspring. This method is recommended over the fbati routine in most scenarios.

If no arguments are passed, then a friendly graphical interface is presented to the user.

fbatge [GxE test], fbatj (see fbatj help) [G,GxE test], fbatme (see fbatme help) [G test] generally have more options than fbatgeAll. fbatgeAll runs all three tests, and gives results of all of them, and so uses only the options that are common to all three functions.

Usage

1
2
3
4
5
fbatge( ped=NULL, phe=NULL,
        env=NULL, cov=NULL,
        trait="AffectionStatus", geno=NULL,
        strategy="hybrid", model="additive" )
fbatgeAll( ped=NULL, phe=NULL, env=NULL, trait="AffectionStatus" )

Arguments

ped

Object from (f)read.ped or as.ped (non-symbolic). See write.ped in the pbatR R package for more details on the file format.

phe

Object from (f)read.phe or as.phe (non-symbolic). See write.phe in the pbatR R package for more details on the file format.

env

Environmental Exposure. Should be a string, corresponding to the name in the 'phe' object.

cov

Any covariates to adjust for (does not apply to RR method). Should be a vector of strings, corresponding to names in the 'phe' object.

trait

Dichotomous trait name. Should be either "AffectionStatus", corresponding to the affection status in the pedigree object, or a string in the phenotype object.

geno

Names of the genetic markers, from the 'ped' object. If NULL (default), then all genetic markers are tested.

strategy

One of 'hybrid' (recommended, most efficient, requires rare disease), 'RR' (relative risk model, generally for a rare disease), or 'CLR' (conditional logistic regression).

model

Either 'additive' for the additive genetic model, or 'codominant' for the codominant genetic model (indicator variables for the genotypes).

Details

Implements the test as described in Hoffmann et. al. (please see References).

NOTE: The allele frequency is simply based on the allele frequency in all genotyped individuals, and is not the best choice.

References

Hoffmann, Thomas J., and Laird, Nan M. Combining Multiple Disease Models for a More Powerful Gene-Environment Interaction Test in Nuclear Families.

Examples

1
2
3
4
  example( fbati ) ## See fbati, creates a dataset for us in 'phe' and 'ped'
  print( fbatge( ped=ped, phe=phe, env="env" ) )
  ## The results are very close to the FBAT-I function, which
  ##  we would expect for trios.

fbati documentation built on April 23, 2018, 5:05 p.m.