nIndividual: Number of individuals in a pedigree

In GeneticsPed: Pedigree and genetic relationship functions

Description

nIndividual returns number of individuals (individuals 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: "id" (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 individuals in a pedigree as described in Pedigree. However, nlevels.Pedigree prints out the number of levels actually used to represent individuals 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 individuals with unknown fathers - FIXME
  # ped <- ped[!is.na(ped, col="father"), ]
  # nIndividual(ped)
  # nIndividual(ped, extend=FALSE)

Example output

Loading required package: MASS

Attaching package: ‘GeneticsPed’

The following object is masked from ‘package:stats’:

    family

[1] 15
[1] 4
[1] 4

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