check_reference {purgeR}

Check columns with reference individuals

Description

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.

Usage

check_reference(ped, reference)

check_target(ped, reference, target, variable)

Arguments

ped

A dataframe containing the pedigree. Individual (id), maternal (dam), and paternal (sire) identities are mandatory columns.

reference

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

target

Target column

variable

To be used in printed messages

Value

Vector of reference numbers (if checks are successful)

Vector of target numbers (if checks are successful)