check_reference

check_target

Takes a column name, and checks its use as reference.
It should name a boolean vector (or coercible to it),
with at least one TRUE value.
Takes a column name, and checks its use as target.
It should name a boolean vector (or coercible to it),
with at least one TRUE value.

Inbreeding-purging analysis of pedigreed populations, including the computation of the inbreeding coefficient, partial, ancestral and purged inbreeding coefficients, and measures of the opportunity of purging related to the individual reduction of inbreeding load.
In addition, functions to calculate the effective population size and other parameters relevant to population genetics are included.
See López-Cortegano E. (2021) <doi:10.1093/bioinformatics/btab599>.

Eugenio L<c3><b3>pez-Cortegano

purgeR

Inbreeding-Purging Estimation in Pedigreed Populations

Eugenio López-Cortegano

check_reference function

<dl><dt>ped</dt>
<dd>A dataframe containing the pedigree. Individual (id), maternal (dam), and paternal (sire) identities are mandatory columns.</dd>
<dt>reference</dt>
<dd>A string naming a column indicating whether individuals belong to the reference population or not. Column must be boolean or coercible to boolean type.</dd>
<dt>target</dt>
<dd>Target column</dd>
<dt>variable</dt>
<dd>To be used in printed messages</dd></dl>

Arguments

Check columns with reference individuals — check_reference

<dl>

<dt>ped</dt>
<dd>A dataframe containing the pedigree. Individual (id), maternal (dam), and paternal (sire) identities are mandatory columns.</dd>


<dt>reference</dt>
<dd>A string naming a column indicating whether individuals belong to the reference population or not. Column must be boolean or coercible to boolean type.</dd>


<dt>target</dt>
<dd>Target column</dd>


<dt>variable</dt>
<dd>To be used in printed messages</dd>

</dl>

check_reference: Check columns with reference individuals

Description

Usage

Value

Arguments