founder: Founder and non-founder individuals in the pedigree

In GeneticsPed: Pedigree and genetic relationship functions

Description

isFounder classifies individuals in the pedigree as founders (base) or non-founders (non-base individuals).

Usage

  isFounder(x, col=attr(x, ".ascendant"))

Arguments

x	pedigree object
col	character, which columns should be checked, see examples

Details

By definition founders do not have any known ascendants, while the opossite is the case for non-founders i.e. they have at least one known ascendant.

FIXME: any relation with founderGeneSet in GeneticsBase

Value

Boolean vector.

Author(s)

Gregor Gorjanc

See Also

Pedigree

Examples

  ped <- generatePedigree(nId=5)
  isFounder(ped)
  ## Based only on fathers
  isFounder(ped, col=c("father"))
  ## Works also only on a part of a pedigree
  isFounder(ped[1:5, ])

Example output

Loading required package: MASS

Attaching package: 'GeneticsPed'

The following object is masked from 'package:stats':

    family

 [1]  TRUE  TRUE  TRUE  TRUE  TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE
[13] FALSE FALSE FALSE
 [1]  TRUE  TRUE  TRUE  TRUE  TRUE FALSE FALSE FALSE FALSE FALSE FALSE FALSE
[13] FALSE FALSE FALSE
   1    2    3    4    5 
TRUE TRUE TRUE TRUE TRUE 

GeneticsPed documentation built on Nov. 8, 2020, 5:54 p.m.