dviData {dvir}R Documentation

DVI data

Description

DVI data

Usage

dviData(pm, am, missing, generatePairings = TRUE)

checkDVI(
  dvi,
  pairings = NULL,
  errorIfEmpty = FALSE,
  ignoreSex = FALSE,
  verbose = TRUE
)

Arguments

pm

A list of singletons: The victim samples.

am

A list of pedigrees: The reference families.

missing

A character vector with names of missing persons.

generatePairings

A logical. If TRUE (default) a list of sex-compatible pairings is included as part of the output.

dvi

A dviData object.

pairings

A list of pairings.

errorIfEmpty

A logical.

ignoreSex

A logical.

verbose

A logical.

Value

An object of class dviData, which is basically a list of pm, am, missing and pairings.

Examples

dvi = dviData(pm = singleton("V1"), am = nuclearPed(1), missing = "3")
dvi

checkDVI(dvi)


[Package dvir version 3.2.1 Index]