profileSimParametric: Simulate complete DNA profiles given IBD coefficients

View source: R/pairwiseSim.R

profileSimParametricR Documentation

Simulate complete DNA profiles given IBD coefficients

Description

This function generalises markerSimParametric() in the same way that profileSim() generalises markerSim().

Usage

profileSimParametric(
  kappa = NULL,
  delta = NULL,
  states = NULL,
  N = 1,
  freqList = NULL,
  seed = NULL,
  returnValue = c("singletons", "alleles", "genotypes", "internal")
)

Arguments

kappa

A probability vector of length 3, giving a set of realised kappa coefficients (between two noninbred individuals).

delta

A probability vector of length 9, giving a set of condensed identity coefficients (Jacquard coefficients).

states

An integer vector of length N, with entries in 1-9. Each entry gives the identity state of the corresponding marker. (See details.)

N

A positive integer: the number of complete profiles to be simulated

freqList

A list of numeric vectors. Each vector is the allele frequencies of a marker.

seed

An integer seed for the random number generator (optional).

returnValue

Either "singleton" (default) or "alleles". (see Value).

Value

A list of length N, whose entries are determined by returnValue, as explained in markerSimParametric().

Examples

# A single profile with 9 markers, each with forced identity state
profileSimParametric(states = 1:9, freqList = NorwegianFrequencies[1:9])


forrel documentation built on March 18, 2022, 5:19 p.m.