stripPedigree: Strip pedigree of unneccessary lines

Description Usage Arguments Details Value

View source: R/stripPedigree.R

Description

Strip pedigree of lines that make no genetic contribution to the specified set of lines.

Usage

1
stripPedigree(pedigree, finalLines)

Arguments

pedigree

The initial pedigree, which may contain some unneccessary extra genetic lines

finalLines

The list of lines of interest. Lines in the pedigree which do not make a genetic contribution to the lines in finalLines will be removed.

Details

Pedigrees for structured experiments can be messy. Often they include lines that make no genetic contribution to the lines that were finally genotyped. When it comes to visualising the structure of the pedigree of the final population, these unneccessary extra lines can make it difficult to see the structure. This function takes in a pedigree and a list of genetic lines, and returns a subpedigree that contains only those lines that make a genetic contribution to the named lines.

This function relies on the use of the Boost C++ libraries, and may not be available in every distributed version of mpMap2. If this function is unavailable, the function will return NULL.

Value

An object of class detailedPedigree representing the experimental design, suitable for simulation using simulateMPCross.


rohan-shah/mpMap2 documentation built on July 21, 2020, 8:58 p.m.