nIndividual {GeneticsPed}R Documentation

Number of individuals in a pedigree

Description

nIndividual returns number of individuals (subjects and/or ascendants) in a pedigree object.

Usage

nIndividual(x, col=NULL, extend=TRUE, drop=TRUE)

Arguments

x pedigree
col character, which id column should be the source: "subject" (default) or particular ascendant i.e. "father" and "mother"
extend logical, extend pedigree
drop logical, drop unused levels in case factors are used

Details

FIXME - this will change a lot!!!! There is always one additional level in levels in case factors are used to represent subjects in a pedigree as described in Pedigree. However, nlevels.Pedigree prints out the number of levels actually used to represent subjects i.e. level unknown is not included into the result.

Author(s)

Gregor Gorjanc

See Also

summary.Pedigree, extend

Examples

  # Deafult example
  ped <- generatePedigree(5)
  nIndividual(ped)

  # Other id columns
  nIndividual(ped, col="father")
  nIndividual(ped, col="mother")

  # Remove subjects with unknown fathers - FIXME
  # ped <- ped[!is.na(ped, col="father"), ]
  # nIndividual(ped)
  # nIndividual(ped, extend=FALSE)

[Package GeneticsPed version 1.0.0 Index]