checkPedigreeNetwork: Validate Pedigree Network Structure

View source: R/checkPedigree.R

checkPedigreeNetworkR Documentation

Validate Pedigree Network Structure

Description

Checks for structural issues in pedigree networks, including: - Individuals with more than two parents. - Presence of cyclic parent-child relationships.

Usage

checkPedigreeNetwork(
  ped,
  personID = "ID",
  momID = "momID",
  dadID = "dadID",
  verbose = FALSE
)

Arguments

ped

Dataframe representing the pedigree.

personID

Character. Column name for individual IDs.

momID

Character. Column name for maternal IDs.

dadID

Character. Column name for paternal IDs.

verbose

Logical. If TRUE, print informative messages.

Value

List containing detailed validation results.

Examples

## Not run: 
results <- checkPedigreeNetwork(ped, personID = "ID",
momID = "momID", dadID = "dadID", verbose = TRUE)

## End(Not run)

R-Computing-Lab/BGMisc documentation built on April 3, 2025, 3:12 p.m.