ped2maternal {BGmisc} | R Documentation |
Add a maternal line ID variable to a pedigree
Description
Add a maternal line ID variable to a pedigree
Usage
ped2maternal(
ped,
personID = "ID",
momID = "momID",
dadID = "dadID",
matID = "matID"
)
Arguments
ped |
a pedigree dataset. Needs ID, momID, and dadID columns |
personID |
character. Name of the column in ped for the person ID variable |
momID |
character. Name of the column in ped for the mother ID variable |
dadID |
character. Name of the column in ped for the father ID variable |
matID |
Character. Maternal line ID variable to be created and added to the pedigree |
Details
Under various scenarios it is useful to know which people in a pedigree belong to the same maternal lines. This function first turns a pedigree into a graph where adjacency is defined by mother-child relationships. Subsequently, the weakly connected components algorithm finds all the separate maternal lines and gives them an ID variable.
See Also
[ped2fam()] for creating extended family IDs, and [ped2paternal()] for creating paternal line IDs