checkPedigreeFile: Check a pedigree file

Description Usage Arguments Details Value Author(s) Examples

View source: R/checkPedigreeFile.R

Description

Given a pedigree file path the function attempts to load it and compare it to the reference profiles to detect possible errors.

Usage

1
checkPedigreeFile(filename, df)

Arguments

filename

Path of the pedigree file

df

Data frame with reference profiles

Details

The pedigree file must be a .R file defining a pedigree (see the relMix vignette for an example). The data frame with reference data is used to compare names of individuals and detect possible misspellings. If warnings are found, the function attempts to fix them and explains what it has done in the warning messages. If an error is found, checking stops. The error is described in the error messages.

Value

A list containing

Author(s)

Elias Hernandis

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
#First load mixture file
mixfile <- system.file("extdata","mixture_silent_ex.txt",package="relMix")
mix <- checkMixtureFile(mixfile);
#Load reference file
reffile <- system.file("extdata","references_silent.txt",package="relMix")
ref <- checkReferenceFile(reffile, mix$df)
#Check pedigree file
pedfile <- system.file("extdata","custom_pedigree_maternity_duo.R",package="relMix")
checkPedigreeFile(pedfile,ref$df);

## End(Not run)

relMix documentation built on Dec. 15, 2020, 5:11 p.m.