getComponent

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

A comprehensive collection of tools for creating,
manipulating and visualising pedigrees and genetic marker data.
Pedigrees can be read from text files or created on the fly with
built-in functions. A range of utilities enable modifications like
adding or removing individuals, breaking loops, and merging pedigrees.
An online tool for creating pedigrees interactively, based on
'pedtools', is available at <https://magnusdv.shinyapps.io/quickped>.
'pedtools' is the hub of the 'pedsuite', a collection of packages for
pedigree analysis. A detailed presentation of the 'pedsuite' is given
in the book 'Pedigree Analysis in R' (Vigeland, 2021,
ISBN:9780128244302).

Magnus Vigeland

pedtools

Creating and Working with Pedigrees and Marker Data

Magnus Dehli Vigeland

getComponent function

<dl><dt>x</dt>
<dd>A <code>ped</code> object, or a list of such.</dd>
<dt>ids</dt>
<dd>A vector of ID labels (coercible to character).</dd>
<dt>checkUnique</dt>
<dd>A logical, by default FALSE. If TRUE, an error is raised
if any element of <code>ids</code> occurs more than once in <code>x</code>.</dd>
<dt>errorIfUnknown</dt>
<dd>A logical, by default FALSE. If TRUE, the function
stops with an error if not all elements of <code>ids</code> are found in <code>x</code>.</dd></dl>

Arguments

Pedigree component — getComponent

<dl>

<dt>x</dt>
<dd>A <code>ped</code> object, or a list of such.</dd>


<dt>ids</dt>
<dd>A vector of ID labels (coercible to character).</dd>


<dt>checkUnique</dt>
<dd>A logical, by default FALSE. If TRUE, an error is raised
if any element of <code>ids</code> occurs more than once in <code>x</code>.</dd>


<dt>errorIfUnknown</dt>
<dd>A logical, by default FALSE. If TRUE, the function
stops with an error if not all elements of <code>ids</code> are found in <code>x</code>.</dd>

</dl>

getComponent: Pedigree component

Description

Usage

Value

Arguments

See Also

Examples