check_basic {purgeR}

Check basic

Description

This function will group some other checking functions, that should be run everytime when using functions in this package, to avoid unexpected errors.

Usage

check_basic(
  ped,
  id_name = "id",
  dam_name = "dam",
  sire_name = "sire",
  when_rename = FALSE,
  when_sort = FALSE
)

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.

when_rename

True when called from ped_rename function. It softs checks on individual ID column name and types

when_sort

True when called from ped_sort function. It softs checks on pedigree sorting

Value

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