monteCarloSharingProb: calculates sharing probability by simulating pedigree...

Description Usage Arguments Value

View source: R/monteCarloMethods.R

Description

Calculates the same exact probability as RVsharing, except uses monte carlo simulation instead of exact computation. This method allows for more flexibility in the scenarios considered.

Usage

1
2
3
4
5
6
7
8
monteCarloSharingProb(
  procPed,
  alleleFreq = NA,
  kinshipCoeff = NA,
  nSim,
  founderDist = NULL,
  kinshipOrder = 5
)

Arguments

procPed

pedigree that has been through processPedigree

alleleFreq

allele frequency among the founders

kinshipCoeff

mean kinship coefficient among the founders

nSim

number of simulations used in monte carlo calculation

founderDist

custom distribution among founders. Only used when simulating probability with nSim

kinshipOrder

order of the polynomial approximation to the distribtion of the number of distinct alleles in the founders (d in Bureau et al.). Must be <= 5

Value

sharing probability between all carriers in pedigree


RVS documentation built on Nov. 8, 2020, 6:57 p.m.