as_kinship2_pedigree

Convert pedigree to kinship2 format

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

as_kinship2_pedigree function

<dl><dt>x</dt>
<dd>A <code>ped()</code> object.</dd>
<dt>deceased</dt>
<dd>A vector of labels indicating deceased pedigree members.</dd>
<dt>aff</dt>
<dd>A vector of labels identifying members whose plot symbols should
be filled. (This is typically used in medical pedigrees to indicate
affected members.)</dd>
<dt>twins</dt>
<dd>A data frame with columns <code>id1</code>, <code>id2</code> and <code>code</code>, passed on to
the <code>relation</code> parameter of <code>kinship2::plot.pedigree()</code>.</dd>
<dt>hints</dt>
<dd>An optional list of hints passed on to
<code>kinship2::align.pedigree()</code>.</dd></dl>

Arguments

Convert pedigree to kinship2 format — as_kinship2_pedigree

<dl>

<dt>x</dt>
<dd>A <code>ped()</code> object.</dd>


<dt>deceased</dt>
<dd>A vector of labels indicating deceased pedigree members.</dd>


<dt>aff</dt>
<dd>A vector of labels identifying members whose plot symbols should
be filled. (This is typically used in medical pedigrees to indicate
affected members.)</dd>


<dt>twins</dt>
<dd>A data frame with columns <code>id1</code>, <code>id2</code> and <code>code</code>, passed on to
the <code>relation</code> parameter of <code>kinship2::plot.pedigree()</code>.</dd>


<dt>hints</dt>
<dd>An optional list of hints passed on to
<code>kinship2::align.pedigree()</code>.</dd>

</dl>

as_kinship2_pedigree: Convert pedigree to kinship2 format

Description

Usage

Arguments

Examples