check_names: Check that mandatory column names are included

View source: R/check.R

check_namesR Documentation

Check that mandatory column names are included

Description

Columns for id, dam and sire are mandatory. This function checks that they are named in the pedigree. The function works with arbitrary column names (not 'id', 'dam' and 'sire') to work with ped_rename()

Usage

check_names(ped, id_name = "id", dam_name = "dam", sire_name = "sire")

Arguments

ped

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

id_name

Column name for individual id.

dam_name

Column name for dam.

sire_name

Column name for sire.

Value

No return value. Will print an error message if checking fail.


purgeR documentation built on Aug. 16, 2023, 9:07 a.m.