zalpha (version 0.3.0)

Zbeta_expected: Runs the Zbeta function on the expected r-squared values for the region

Description

Returns a $Z_{\beta }^{E[r^2]}$ value for each SNP location supplied to the function, based on the expected $r^2$ values given an LD profile and genetic distances. For more information about the $Z_{\beta }^{E[r^2]}$ statistic, please see Jacobs (2016). The $Z_{\beta }^{E[r^2]}$ statistic is defined as: $$Z_{\beta }^{E[r^2]}=\frac{\sum _{i\in L,j\in R}E[r_{i,j}^2]}{|L||R|}$$ where |L| and |R| are the number of SNPs to the left and right of the current locus within the given window ws, and $E[r^2]$ is equal to the expected squared correlation between a pair of SNPs, given an LD profile.

Usage

Zbeta_expected(
  pos,
  ws,
  dist,
  LDprofile_bins,
  LDprofile_rsq,
  minRandL = 4,
  minRL = 25,
  X = NULL
)

Arguments

pos

A numeric vector of SNP locations

ws

The window size which the $Z_{\beta }^{E[r^2]}$ statistic will be calculated over. This should be on the same scale as the pos vector.

dist

A numeric vector of genetic distances (e.g. cM, LDU). This should be the same length as pos.

LDprofile_bins

A numeric vector containing the lower bound of the bins used in the LD profile. These should be of equal size.

LDprofile_rsq

A numeric vector containing the expected $r^2$ values for the corresponding bin in the LD profile. Must be between 0 and 1.

minRandL

Minimum number of SNPs in each set R and L for the statistic to be calculated. Default is 4.

minRL

Minimum value for the product of the set sizes for R and L. Default is 25.

X

Optional. Specify a region of the chromosome to calculate $Z_{\beta }^{E[r^2]}$ for in the format c(startposition, endposition). The start position and the end position should be within the extremes of the positions given in the pos vector. If not supplied, the function will calculate $Z_{\beta }^{E[r^2]}$ for every SNP in the pos vector.

Value

A list containing the SNP positions and the $Z_{\beta }^{E[r^2]}$ values for those SNPs

Details

The LD profile describes the expected correlation between SNPs at a given genetic distance, generated using simulations or real data. Care should be taken to utilise an LD profile that is representative of the population in question. The LD profile should consist of evenly sized bins of distances (for example 0.0001 cM per bin), where the value given is the (inclusive) lower bound of the bin. Ideally, an LD profile would be generated using data from a null population with no selection, however one can be generated using this data. See the create_LDprofile function for more information on how to create an LD profile.

References

Jacobs, G.S., T.J. Sluckin, and T. Kivisild, Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps. Genetics, 2016. 203(4): p. 1807

See Also

create_LDprofile

Examples

# NOT RUN {
## load the snps and LDprofile example datasets
data(snps)
data(LDprofile)
## run Zbeta_expected over all the SNPs with a window size of 3000 bp
Zbeta_expected(snps$bp_positions,3000,snps$cM_distances,LDprofile$bin,LDprofile$rsq)
## only return results for SNPs between locations 600 and 1500 bp
Zbeta_expected(snps$bp_positions,3000,snps$cM_distances,LDprofile$bin,LDprofile$rsq,X=c(600,1500))

# }