quickLR: LR calculations for paternity and sibship

View source: R/quickLR.R

quickLRR Documentation

LR calculations for paternity and sibship

Description

A thin wrapper around kinshipLR() for the common scenario of testing a pair of individuals for paternity and/or sibship, against being unrelated.

Usage

quickLR(x, ids = typedMembers(x), test = c("pat", "sib", "half"))

Arguments

x

A ped object or a list of such.

ids

A vector of two typed members of x. If not given, the typed members of x are selected by default, but note that this gives an error if the number of such individuals is not 2.

test

The hypotheses to be tested (against 'unrelatedness'). Allowed values are "pat" (=paternity), "sib" (=full siblings), and "half" (=half siblings). By default, all three are included.

Value

A (slightly simplified) LRresult object, as described in kinshipLR().

Examples

# Simulate 100 markers for half siblings
x = halfSibPed() |> markerSim(N = 100, ids = 4:5, alleles = 1:3, seed = 1)

# Test paternity, full sib, half sib
quickLR(x)


forrel documentation built on Sept. 11, 2024, 9:15 p.m.