check_tcol {purgeR}

Check columns with generation numbers

Description

Takes a column name, and checks its use as generation numbers. It should name a numeric vector, with values >= 0.

Usage

check_tcol(ped, tcol, compute = TRUE, force_int = FALSE)

Arguments

ped

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

tcol

Name of column with individual generation times. If none is used, the number of equivalent complete generations is computed.

compute

Compute generation numbers if tcol is NULL

force_int

Generation numbers must be integers (disabled by default)

Value

Vector of generation numbers (if checks are successful)