ped_prep: Preprocess pedigree

Description Usage Arguments Details Value See Also

Description

ped_prep() prepares the given pedigree by recoding missing ids to NA, checking for duplicate records and some more checks. This is usually the first step before any further calculations are performed.

Usage

1
ped_prep(pedigree, na_id_rm = FALSE)

Arguments

pedigree

an object coercible to a data.table which includes the id of individual, sire and dam.

na_id_rm

a logical indicating whether to remove individuals coded as missing or unkown. When set to FALSE it will return an error.

Details

The first three columns are assumed to be the id of the individual, sire and dam, respectively in that order. New columns .id, .sire and .dam are created which are used by other functions in this package.

Value

a data.table containing the original ids and new id columns used in further calculation steps

See Also

ped_add() is a function that relies on preprocessing before adding the missing parents, for example.


tstev/pedr documentation built on May 11, 2019, 4:06 p.m.