pedigree: Create a pedigree object

Description Usage Arguments Details Value

View source: R/pedigree.R

Description

Create a pedigree object

Usage

1
pedigree(lineNames, mother, father, selfing, warnImproperFunnels = TRUE)

Arguments

lineNames

The names of the genetic lines

mother

The index of the maternal line

father

The index of the paternal line

selfing

Should the number of generations of selfing be taken from the pedigree ("finite"), or should selfing be assumed to be infinite ("infinite")?

warnImproperFunnels

Should a warning be generated in subsequent computations using this pedigree, if there are lines which do not contain all founding lines as ancestors?

Details

This function creates a pedigree object from parts. All lines are assumed to have an index, starting at 1 for the first line. Values at index of the various inputs 1 all relate to the first line, values at index 2 all relate to the second line, etc.

Input lineNames assigns a name to every line. Input mother gives the index of a mother line, where a value of 0 indicates that a line is a founder of the population (and therefore inbred). Input father gives the index of a father line, where a value of 0 indicates that a line is a founder of the population (and therefore inbred). Input selfing must be "finite" or "infinite". A value of infinite means that the number of generations of selfing for this pedigree will be assumed to be infinite. A value of "finite" means that the number of generations of selfing will be computed from the pedigree, for every line.

Value

An object of class pedigree representing the inputs.


mpMap2 documentation built on Sept. 13, 2020, 5:17 p.m.