checkArgs: check arguments provided to RVsharing for validty
In RVS: Computes estimates of the probability of related individuals sharing a rare variant
Description
Usage
Arguments
Value
Description
verifies that arguments are valid, throws an error
if they are not
Usage
1
checkArgs(alleleFreq, kinshipCoeff, nSim, founderDist)
Arguments
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
Value
throws error if arguments invalid
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 Value
Description
verifies that arguments are valid, throws an error if they are not
Usage
1 | checkArgs(alleleFreq, kinshipCoeff, nSim, founderDist)
|
Arguments
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 |
Value
throws error if arguments invalid
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.