| mldest {ldsep} | R Documentation |
Estimate all pair-wise LD's in a collection of SNPs using genotypes or genotype likelihoods.
Description
This function is a wrapper to run ldest() for many pairs of
SNPs. This takes a maximum likelihood approach to LD estimation. See
ldfast() for a method-of-moments approach to LD estimation.
Support is provided for parallelization through the foreach and doParallel
packages. See Gerard (2021) for details.
Usage
mldest(
geno,
K,
nc = 1,
type = c("hap", "comp"),
model = c("norm", "flex"),
pen = ifelse(type == "hap", 2, 1),
se = TRUE
)
Arguments
geno |
One of two possible inputs:
|
K |
The ploidy of the species. Assumed to be the same for all individuals. |
nc |
The number of computing cores to use. This should never be
more than the number of cores available in your computing environment.
You can determine the maximum number of available cores by running
|
type |
The type of LD to calculate. The available types are
haplotypic LD ( |
model |
When |
pen |
The penalty to be applied to the likelihood. You can think about
this as the prior sample size. Should be greater than 1. Does not
apply if |
se |
A logical. Should we calculate standard errors ( |
Details
See ldest() for details on the different types of LD
estimators supported.
Value
A data frame of class c("lddf", "data.frame")
with some or all of the following elements:
iThe index of the first SNP.
jThe index of the second SNP.
snpiThe row name corresponding to SNP
i, if row names are provided.snpjThe row name corresponding to SNP
j, if row names are provided.DThe estimate of the LD coefficient.
D_seThe standard error of the estimate of the LD coefficient.
r2The estimate of the squared Pearson correlation.
r2_seThe standard error of the estimate of the squared Pearson correlation.
rThe estimate of the Pearson correlation.
r_seThe standard error of the estimate of the Pearson correlation.
DprimeThe estimate of the standardized LD coefficient. When
type= "comp", this corresponds to the standardization where we fix allele frequencies.Dprime_seThe standard error of
Dprime.DprimegThe estimate of the standardized LD coefficient. This corresponds to the standardization where we fix genotype frequencies.
Dprimeg_seThe standard error of
Dprimeg.zThe Fisher-z transformation of
r.z_seThe standard error of the Fisher-z transformation of
r.p_abThe estimated haplotype frequency of ab. Only returned if estimating the haplotypic LD.
p_AbThe estimated haplotype frequency of Ab. Only returned if estimating the haplotypic LD.
p_aBThe estimated haplotype frequency of aB. Only returned if estimating the haplotypic LD.
p_ABThe estimated haplotype frequency of AB. Only returned if estimating the haplotypic LD.
q_ijThe estimated frequency of genotype i at locus 1 and genotype j at locus 2. Only returned if estimating the composite LD.
nThe number of individuals used to estimate pairwise LD.
Author(s)
David Gerard
References
Gerard, David. "Pairwise Linkage Disequilibrium Estimation for Polyploids." Molecular Ecology Resources 21, no. 4 (2021): 1230-1242. doi:10.1111/1755-0998.13349
See Also
ldfast()Fast, moment-based approach to LD estimation that also accounts for genotype uncertainty.
ldest()For the base function that estimates pairwise LD.
sldest()For estimating pairwise LD along a sliding window.
format_lddf()For formatting the output of
mldest()as a matrix.plot.lddf()For plotting the output of
mldest().
Examples
set.seed(1)
## Simulate genotypes when true correlation is 0
nloci <- 5
nind <- 100
K <- 6
nc <- 1
genomat <- matrix(sample(0:K, nind * nloci, TRUE), nrow = nloci)
## Composite LD estimates
lddf <- mldest(geno = genomat,
K = K,
nc = nc,
type = "comp")
lddf[1:6, 1:6]