pedtools (version 0.9.6)

getComponent: Pedigree component

Description

Given a list of ped objects (called pedigree components), and a vector of ID labels, find the index of the component holding each individual.

Usage

getComponent(x, ids, checkUnique = FALSE)

Arguments

x

A list of ped objects

ids

A vector of ID labels (coercible to character)

checkUnique

If TRUE an error is raised if any element of ids occurs more than once in x.

Value

An integer vector of the same length as ids, with NA entries where the corresponding label was not found in any of the components.

Examples

# NOT RUN {
x = list(nuclearPed(1), singleton(id = "A"))
getComponent(x, c(3, "A")) # = c(1, 2)

# }