zeroIBD: Probability of zero IBD

Description Usage Arguments Value Examples

View source: R/zeroIBD.R

Description

Estimate the probability of no IBD sharing in a pairwise relationship.

Usage

1
zeroIBD(sims, ids = NULL, threshold = 0)

Arguments

sims

A list of genome simulations, as output by ibdsim().

ids

A vector with two ID labels. If NULL (default), these are deduced from the sims object.

threshold

A nonnegative number (default:0). Only IBD segments longer than this are included in the computation.

Value

A list with the following two entries:

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
###
# The following example computes the probability of
# no IBD sharing between a pair of fourth cousins.
# We also show how the probability is affected by
# truncation, i.e., ignoring short segments.
###

# Define the pedigree
x = cousinPed(4)
cous = leaves(x)

# Simulate (increase N!)
s = ibdsim(x, N = 10)

# Probability of zero ibd segments. (By default all segs are used)
zeroIBD(s, ids = cous)

# Re-compute with positive threshold
zeroIBD(s, ids = cous, threshold = 1)

ibdsim2 documentation built on Nov. 13, 2020, 5:06 p.m.