getComponent {pedtools} | R Documentation |
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, errorIfUnknown = FALSE)
Arguments
x |
A list of |
ids |
A vector of ID labels (coercible to character) |
checkUnique |
If TRUE an error is raised if any element of |
errorIfUnknown |
If TRUE, the function stops with an error if not all
elements of |
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.
See Also
Examples
x = list(nuclearPed(1), singleton(id = "A"))
getComponent(x, c(3, "A"))
[Package pedtools version 2.6.0 Index]