nvariant: Number of Variants function

In meganmichelle/RAREsim: Simulation of Rare Variant Genetic Data

Number of Variants function

Description

The Number of Variants (nvariant) function calculates the number of variants per kilobase, as described in RAREsim. N is the number of individuals. The Number of Variants function changes with N. The default parameters will be used if an ancestrial population is specified: (AFR, EAS, NFE, or SAS) is specified. Otherwise, the parameters phi and omega need to be provided. Phi and omega can be estimated from target data using the Fit_nvariant function.

Usage

nvariant(phi = NULL, omega = NULL, N, pop = NULL)

Arguments

phi	parameter phi
omega	parameter omega
N	sample size in number of individuals
pop	population - only needs to be specified if using default parameters

Value

the number of variants per kb

Examples

nvariant(N = 8128, pop = 'AFR')
nvariant(phi = 0.1638108, omega = 0.6248848, N = 8128)

meganmichelle/RAREsim documentation built on June 11, 2022, 7:34 p.m.