optiSel (version 0.9.1)

prePed: Prepares a Pedigree

Description

Prepares a pedigree by sorting and adding founders and pruning the pedigree.

Usage

prePed(Pedig, keep=NULL, thisBreed=NA, lastNative=NA, addNum=FALSE, I=0)

Arguments

Pedig

Data frame containing the pedigree where the first 3 columns correspond to: Individual ID, Sire, and Dam. More columns can be passed in the Pedig argument including columns named Sex, Breed (with breed names), and Born (with years of birth). Missing parents are coded as NA, 0, or "0".

keep

Vector with IDs of individuals, or NULL, or a logical vector indicating the individuals to be kept. If this parameter is not NULL, then only these individuals and their ancestors will be kept in the pedigree.

thisBreed

Name of the breed.

lastNative

Last year of birth for which individuals with unknown pedigree are considered native.

addNum

If TRUE, then columns with IDs of individuals, sires, and dams in integer form will be added.

I

offset

Value

A data frame containing the pedigree.

Details

This function takes a pedigree, adds missing founders, and sorts the pedigree. If parameter keep contains IDs of individuals then only these individuals and their ancestors will be kept in the pedigree.

If the pedigree contains loops, then the loops will be broken by setting the parents of one animal in each loop to NA.

If the pedigree contains columnn Sex then the sexes will be recoded as 'male' and 'female'. Missing sexes will be determined from pedigree structure if possible.

If the pedigree contains column Breed then for ancestors with missing breed the breed name is estimated. If parameter lastNative is not NA then for each animal with one missing parent an imaginary founder is added to the pedigree in order to enable classifying the breed names of all founders as follows: In general animals with missing breed are assumed to have the same breed as most of their offspring. But there is one exception: For founders belonging to thisBreed who are born after lastNative the breed name will be set to "unknown". Moreover for founders from thisBreed with unknown year of birth the breed name will be set to "unknown" if all their descendants are born after lastNative+I.

Examples

# NOT RUN {
data(PedigWithErrors)
Pedig <- prePed(PedigWithErrors)
# }