runMonteCarlo: run the monte carlo simulation
In RVS: Computes estimates of the probability of related individuals sharing a rare variant
Description
Usage
Arguments
Details
Value
View source: R/monteCarloMethods.R
Description
Given a number of simulations and a distribution
of variants in the founders, this function simulates possbile
outcomes of the pedigree and returns a sharing probability.
Usage
1
runMonteCarlo(procPed, founderDist, nSim)
Arguments
procPed
pedigree that has been through processPedigree
founderDist
custom distribution among founders. Only used
when simulating probability with nSim
nSim
number of simulations used in monte carlo calculation
Details
If the number of simulations is greater than 20,000
then the computation is done in parallel (as long as the package
parallel is available)
Value
sharing probability between all carriers in pedigree
RVS documentation built on Nov. 8, 2020, 6:57 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Details Value
View source: R/monteCarloMethods.R
Description
Given a number of simulations and a distribution of variants in the founders, this function simulates possbile outcomes of the pedigree and returns a sharing probability.
Usage
1 | runMonteCarlo(procPed, founderDist, nSim)
|
Arguments
procPed |
pedigree that has been through |
founderDist |
custom distribution among founders. Only used when simulating probability with nSim |
nSim |
number of simulations used in monte carlo calculation |
Details
If the number of simulations is greater than 20,000 then the computation is done in parallel (as long as the package parallel is available)
Value
sharing probability between all carriers in pedigree
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.