diff --git a/R/Zalpha_BetaCDF.R b/R/Zalpha_BetaCDF.R index 4ccfd62ca5fd031af3d942d1a44deec995174733..640b13abf5a00c338b99eeeba786834cfdf886d0 100644 --- a/R/Zalpha_BetaCDF.R +++ b/R/Zalpha_BetaCDF.R @@ -14,7 +14,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @importFrom stats cor pbeta na.omit #' @@ -43,6 +44,7 @@ #' LDprofile$bin,LDprofile$Beta_a,LDprofile$Beta_b,X=c(600,1500)) #' #' @export +#' @seealso \code{\link{create_LDprofile}} Zalpha_BetaCDF<-function(pos, ws, x, dist, LDprofile_bins, LDprofile_Beta_a, LDprofile_Beta_b, minRandL = 4, minRL = 25, X = NULL){ #Check things are in the correct format diff --git a/R/Zalpha_Zscore.R b/R/Zalpha_Zscore.R index ecc0c40a18df66fc1f2f6087a46fcc10ac5ce09f..d7f25e9eedf1548cb71f6d91d34b7199fbb5f919 100644 --- a/R/Zalpha_Zscore.R +++ b/R/Zalpha_Zscore.R @@ -13,7 +13,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @importFrom stats cor na.omit #' @@ -42,6 +43,7 @@ #' LDprofile$bin,LDprofile$rsq,LDprofile$sd,X=c(600,1500)) #' #' @export +#' @seealso \code{\link{create_LDprofile}} Zalpha_Zscore<-function(pos, ws, x, dist, LDprofile_bins, LDprofile_rsq, LDprofile_sd, minRandL = 4, minRL = 25, X = NULL){ #Check things are in the correct format diff --git a/R/Zalpha_all.R b/R/Zalpha_all.R index 20c6a0132962f393d89071b85a94cdfc10dd6e14..ec55c1c1a6c933c08252e94c91ed05da4004a1b1 100644 --- a/R/Zalpha_all.R +++ b/R/Zalpha_all.R @@ -11,6 +11,11 @@ #' \item For \code{\link{Zalpha_Zscore}} and \code{\link{Zbeta_Zscore}} to be calculated, the parameter \code{LDprofile_sd} must also be supplied. #' \item For \code{\link{Zalpha_BetaCDF}} and \code{\link{Zbeta_BetaCDF}} to be calculated, the parameters \code{LDprofile_Beta_a} and \code{LDprofile_Beta_b} must also be supplied. #' } +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' For more information about the statistics, please see Jacobs (2016). #' #' @importFrom stats cor pbeta na.omit @@ -45,7 +50,7 @@ #'Zalpha_all(snps$bp_positions,3000,as.matrix(snps[,3:12])) #' #' @export -#' @seealso \code{\link{Zalpha}} \code{\link{Zalpha_expected}} \code{\link{Zalpha_rsq_over_expected}} \code{\link{Zalpha_log_rsq_over_expected}} \code{\link{Zalpha_Zscore}} \code{\link{Zalpha_BetaCDF}} \code{\link{Zbeta}} \code{\link{Zbeta_expected}} \code{\link{Zbeta_rsq_over_expected}} \code{\link{Zbeta_log_rsq_over_expected}} \code{\link{Zbeta_Zscore}} \code{\link{Zbeta_BetaCDF}} \code{\link{LR}} \code{\link{L_plus_R}} +#' @seealso \code{\link{Zalpha}}, \code{\link{Zalpha_expected}}, \code{\link{Zalpha_rsq_over_expected}}, \code{\link{Zalpha_log_rsq_over_expected}}, \code{\link{Zalpha_Zscore}}, \code{\link{Zalpha_BetaCDF}}, \code{\link{Zbeta}}, \code{\link{Zbeta_expected}}, \code{\link{Zbeta_rsq_over_expected}}, \code{\link{Zbeta_log_rsq_over_expected}}, \code{\link{Zbeta_Zscore}}, \code{\link{Zbeta_BetaCDF}}, \code{\link{LR}}, \code{\link{L_plus_R}}, \code{\link{create_LDprofile}}. Zalpha_all <- function(pos, ws, x=NULL, dist=NULL, LDprofile_bins=NULL, LDprofile_rsq=NULL, LDprofile_sd=NULL, LDprofile_Beta_a=NULL, LDprofile_Beta_b=NULL, minRandL = 4, minRL = 25, X = NULL) { #Check things are in the correct format diff --git a/R/Zalpha_expected.R b/R/Zalpha_expected.R index 1112fbf9dfecacf926b7c804ca07151265e0b8b9..e86336679ab280d40d4fe56e4efe53fe22e900f5 100644 --- a/R/Zalpha_expected.R +++ b/R/Zalpha_expected.R @@ -13,7 +13,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @param pos A numeric vector of SNP locations #' @param ws The window size which the \eqn{Z_{\alpha}^{E[r^2]}}{Zalpha} statistic will be calculated over. This should be on the same scale as the \code{pos} vector. @@ -36,7 +37,7 @@ #' Zalpha_expected(snps$bp_positions,3000,snps$cM_distances,LDprofile$bin,LDprofile$rsq,X=c(600,1500)) #' #' @export -#' +#' @seealso \code{\link{create_LDprofile}} Zalpha_expected<-function(pos, ws, dist, LDprofile_bins, LDprofile_rsq, minRandL = 4, minRL = 25, X = NULL) { #Check things are in the correct format diff --git a/R/Zalpha_log_rsq_over_expected.R b/R/Zalpha_log_rsq_over_expected.R index 9548804ca9072184b0e022e145325d7f11134f45..bde2f5cb817cce5111fadb34c47410a7b80d11ba 100644 --- a/R/Zalpha_log_rsq_over_expected.R +++ b/R/Zalpha_log_rsq_over_expected.R @@ -13,7 +13,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @importFrom stats cor na.omit #' @@ -41,6 +42,7 @@ #' LDprofile$bin,LDprofile$rsq,X=c(600,1500)) #' #' @export +#' @seealso \code{\link{create_LDprofile}} Zalpha_log_rsq_over_expected<-function(pos, ws, x, dist, LDprofile_bins, LDprofile_rsq, minRandL = 4, minRL = 25, X = NULL){ #Check things are in the correct format diff --git a/R/Zalpha_rsq_over_expected.R b/R/Zalpha_rsq_over_expected.R index 732c03bfe2483887ea4e67d579a9bd2f28ad3633..56672a3953facc926d06eee33a64b12d3dd62269 100644 --- a/R/Zalpha_rsq_over_expected.R +++ b/R/Zalpha_rsq_over_expected.R @@ -13,7 +13,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @importFrom stats cor na.omit #' @@ -41,6 +42,7 @@ #' LDprofile$bin,LDprofile$rsq,X=c(600,1500)) #' #' @export +#' @seealso \code{\link{create_LDprofile}} Zalpha_rsq_over_expected<-function(pos, ws, x, dist, LDprofile_bins, LDprofile_rsq, minRandL = 4, minRL = 25, X = NULL){ #Check things are in the correct format diff --git a/R/Zbeta_BetaCDF.R b/R/Zbeta_BetaCDF.R index 3be71e6f0b5507b3b12fbf797b29168b96fd44a5..c378482b67c5f8b3dd7e8f64ebe15c92c015fe12 100644 --- a/R/Zbeta_BetaCDF.R +++ b/R/Zbeta_BetaCDF.R @@ -14,7 +14,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @importFrom stats cor pbeta na.omit #' @@ -43,6 +44,7 @@ #' LDprofile$bin,LDprofile$Beta_a,LDprofile$Beta_b,X=c(600,1500)) #' #' @export +#' @seealso \code{\link{create_LDprofile}} Zbeta_BetaCDF<-function(pos, ws, x, dist, LDprofile_bins, LDprofile_Beta_a, LDprofile_Beta_b, minRandL = 4, minRL = 25, X = NULL){ #Check things are in the correct format diff --git a/R/Zbeta_Zscore.R b/R/Zbeta_Zscore.R index 9c4031cdbd9e0dc09e8f6dfa7cd4cd9c0b02f0c4..e2795ddf28cd9156638be62695cc6a0ecce689b1 100644 --- a/R/Zbeta_Zscore.R +++ b/R/Zbeta_Zscore.R @@ -13,7 +13,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @importFrom stats cor na.omit #' @@ -42,6 +43,7 @@ #' LDprofile$bin,LDprofile$rsq,LDprofile$sd,X=c(600,1500)) #' #' @export +#' @seealso \code{\link{create_LDprofile}} Zbeta_Zscore<-function(pos, ws, x, dist, LDprofile_bins, LDprofile_rsq, LDprofile_sd, minRandL = 4, minRL = 25, X = NULL){ #Check things are in the correct format diff --git a/R/Zbeta_expected.R b/R/Zbeta_expected.R index 05bde7062b522501388a95a395baceaac367a6ec..76776da51b627a83c619b406ca9b007eb5579733 100644 --- a/R/Zbeta_expected.R +++ b/R/Zbeta_expected.R @@ -13,7 +13,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @param pos A numeric vector of SNP locations #' @param ws The window size which the \eqn{Z_{\beta}^{E[r^2]}}{Zbeta} statistic will be calculated over. This should be on the same scale as the \code{pos} vector. @@ -36,7 +37,7 @@ #' Zbeta_expected(snps$bp_positions,3000,snps$cM_distances,LDprofile$bin,LDprofile$rsq,X=c(600,1500)) #' #' @export -#' +#' @seealso \code{\link{create_LDprofile}} Zbeta_expected<-function(pos, ws, dist, LDprofile_bins, LDprofile_rsq, minRandL = 4, minRL = 25, X = NULL) { #Check things are in the correct format diff --git a/R/Zbeta_log_rsq_over_expected.R b/R/Zbeta_log_rsq_over_expected.R index 4293b5c03253a3c27ed25d9be4399377f99765fb..d5640bbf6cfcd9fe7d5a761fb1a4573b31dcabde 100644 --- a/R/Zbeta_log_rsq_over_expected.R +++ b/R/Zbeta_log_rsq_over_expected.R @@ -13,7 +13,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @importFrom stats cor na.omit #' @@ -41,6 +42,7 @@ #' LDprofile$bin,LDprofile$rsq,X=c(600,1500)) #' #' @export +#' @seealso \code{\link{create_LDprofile}} Zbeta_log_rsq_over_expected<-function(pos, ws, x, dist, LDprofile_bins, LDprofile_rsq, minRandL = 4, minRL = 25, X = NULL){ #Check things are in the correct format diff --git a/R/Zbeta_rsq_over_expected.R b/R/Zbeta_rsq_over_expected.R index b779188834229795f2528f34ac9bb2c0b8e368be..e0cc7fe392808f172928b0a58eb2341c478e5598 100644 --- a/R/Zbeta_rsq_over_expected.R +++ b/R/Zbeta_rsq_over_expected.R @@ -13,7 +13,8 @@ #' 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. +#' 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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. #' #' @importFrom stats cor na.omit #' @@ -41,6 +42,7 @@ #' LDprofile$bin,LDprofile$rsq,X=c(600,1500)) #' #' @export +#' @seealso \code{\link{create_LDprofile}} Zbeta_rsq_over_expected<-function(pos, ws, x, dist, LDprofile_bins, LDprofile_rsq, minRandL = 4, minRL = 25, X = NULL){ #Check things are in the correct format diff --git a/man/Zalpha_BetaCDF.Rd b/man/Zalpha_BetaCDF.Rd index 4547af62f2d0cc5f5296d949e23598e2753de91a..994bd4306ccfec8e96ad5b57d47f1b2db2ce28b2 100644 --- a/man/Zalpha_BetaCDF.Rd +++ b/man/Zalpha_BetaCDF.Rd @@ -55,7 +55,8 @@ the estimated a and b parameters from the LD profile. 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -72,3 +73,6 @@ Zalpha_BetaCDF(snps$bp_positions,3000,as.matrix(snps[,3:12]),snps$cM_distances, \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zalpha_Zscore.Rd b/man/Zalpha_Zscore.Rd index ec27b088c7a55ec450e4b63cd8f56131da028951..8c21c0103a69704e3fa2deb15aba886a5fd350ad 100644 --- a/man/Zalpha_Zscore.Rd +++ b/man/Zalpha_Zscore.Rd @@ -54,7 +54,8 @@ the squared correlation between a pair of SNPs, \eqn{E[r^2]}{E[r^2]} is equal to 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -71,3 +72,6 @@ Zalpha_Zscore(snps$bp_positions,3000,as.matrix(snps[,3:12]),snps$cM_distances, \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zalpha_all.Rd b/man/Zalpha_all.Rd index 2a5718999cf29a694a4a3dc6d7a4fefb0e331be4..0a30d00392bf9d779768da3bffea4dd0b63763b8 100644 --- a/man/Zalpha_all.Rd +++ b/man/Zalpha_all.Rd @@ -59,6 +59,11 @@ This includes the statistics: \code{\link{Zalpha_expected}}, \code{\link{Zalpha_ \item For \code{\link{Zalpha_Zscore}} and \code{\link{Zbeta_Zscore}} to be calculated, the parameter \code{LDprofile_sd} must also be supplied. \item For \code{\link{Zalpha_BetaCDF}} and \code{\link{Zbeta_BetaCDF}} to be calculated, the parameters \code{LDprofile_Beta_a} and \code{LDprofile_Beta_b} must also be supplied. } +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. For more information about the statistics, please see Jacobs (2016). } \examples{ @@ -80,5 +85,5 @@ Zalpha_all(snps$bp_positions,3000,as.matrix(snps[,3:12])) Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } \seealso{ -\code{\link{Zalpha}} \code{\link{Zalpha_expected}} \code{\link{Zalpha_rsq_over_expected}} \code{\link{Zalpha_log_rsq_over_expected}} \code{\link{Zalpha_Zscore}} \code{\link{Zalpha_BetaCDF}} \code{\link{Zbeta}} \code{\link{Zbeta_expected}} \code{\link{Zbeta_rsq_over_expected}} \code{\link{Zbeta_log_rsq_over_expected}} \code{\link{Zbeta_Zscore}} \code{\link{Zbeta_BetaCDF}} \code{\link{LR}} \code{\link{L_plus_R}} +\code{\link{Zalpha}}, \code{\link{Zalpha_expected}}, \code{\link{Zalpha_rsq_over_expected}}, \code{\link{Zalpha_log_rsq_over_expected}}, \code{\link{Zalpha_Zscore}}, \code{\link{Zalpha_BetaCDF}}, \code{\link{Zbeta}}, \code{\link{Zbeta_expected}}, \code{\link{Zbeta_rsq_over_expected}}, \code{\link{Zbeta_log_rsq_over_expected}}, \code{\link{Zbeta_Zscore}}, \code{\link{Zbeta_BetaCDF}}, \code{\link{LR}}, \code{\link{L_plus_R}}, \code{\link{create_LDprofile}}. } diff --git a/man/Zalpha_expected.Rd b/man/Zalpha_expected.Rd index b2a8ca9519077253ce173d32a949fd1699c93c72..04316d4d96b769cba01a30fe5d748992a850dc69 100644 --- a/man/Zalpha_expected.Rd +++ b/man/Zalpha_expected.Rd @@ -48,7 +48,8 @@ and \eqn{E[r^2]}{E[r^2]} is equal to the expected squared correlation between a 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -63,3 +64,6 @@ Zalpha_expected(snps$bp_positions,3000,snps$cM_distances,LDprofile$bin,LDprofile \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zalpha_log_rsq_over_expected.Rd b/man/Zalpha_log_rsq_over_expected.Rd index 8ef0f96e549ae3c7848e98a7033b32330163decc..ecf83f6944e8aca78b3af9a90a34e6aa9a6b49e5 100644 --- a/man/Zalpha_log_rsq_over_expected.Rd +++ b/man/Zalpha_log_rsq_over_expected.Rd @@ -51,7 +51,8 @@ the squared correlation between a pair of SNPs, and \eqn{E[r^2]}{E[r^2]} is equa 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -68,3 +69,6 @@ Zalpha_log_rsq_over_expected(snps$bp_positions,3000,as.matrix(snps[,3:12]),snps$ \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zalpha_rsq_over_expected.Rd b/man/Zalpha_rsq_over_expected.Rd index 97ecd31aade70d93c9159835e23a8702d77918e7..40431742c993b34a06e61c1906374e7320bbde77 100644 --- a/man/Zalpha_rsq_over_expected.Rd +++ b/man/Zalpha_rsq_over_expected.Rd @@ -51,7 +51,8 @@ the squared correlation between a pair of SNPs, and \eqn{E[r^2]}{E[r^2]} is equa 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -68,3 +69,6 @@ Zalpha_rsq_over_expected(snps$bp_positions,3000,as.matrix(snps[,3:12]),snps$cM_d \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zbeta_BetaCDF.Rd b/man/Zbeta_BetaCDF.Rd index c0fc55f565723d243fa5ed087cd274567ea33863..df3bfb87800da4bb3837bb17556c5aeb5308c4db 100644 --- a/man/Zbeta_BetaCDF.Rd +++ b/man/Zbeta_BetaCDF.Rd @@ -55,7 +55,8 @@ the estimated a and b parameters from the LD profile. 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -72,3 +73,6 @@ Zbeta_BetaCDF(snps$bp_positions,3000,as.matrix(snps[,3:12]),snps$cM_distances, \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zbeta_Zscore.Rd b/man/Zbeta_Zscore.Rd index 91bc7a56c9c44371782f5f4a7c3646324e88a58f..647ccb8ba90dba7c461364a4023f8e80bb45fd04 100644 --- a/man/Zbeta_Zscore.Rd +++ b/man/Zbeta_Zscore.Rd @@ -54,7 +54,8 @@ the squared correlation between a pair of SNPs, \eqn{E[r^2]}{E[r^2]} is equal to 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -71,3 +72,6 @@ Zbeta_Zscore(snps$bp_positions,3000,as.matrix(snps[,3:12]),snps$cM_distances, \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zbeta_expected.Rd b/man/Zbeta_expected.Rd index 7cdfd590addf0864361b6c1b5843356e5ced8529..ffa8030dfb090b1fecdaaf41e0cf59fbb09d4338 100644 --- a/man/Zbeta_expected.Rd +++ b/man/Zbeta_expected.Rd @@ -48,7 +48,8 @@ and \eqn{E[r^2]}{E[r^2]} is equal to the expected squared correlation between a 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -63,3 +64,6 @@ Zbeta_expected(snps$bp_positions,3000,snps$cM_distances,LDprofile$bin,LDprofile$ \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zbeta_log_rsq_over_expected.Rd b/man/Zbeta_log_rsq_over_expected.Rd index 6513c73bc58e767ebad8cd9fd4ce2ce2480b067a..07cfb9e901b4bcd733d42db9777adf39732a8c78 100644 --- a/man/Zbeta_log_rsq_over_expected.Rd +++ b/man/Zbeta_log_rsq_over_expected.Rd @@ -51,7 +51,8 @@ the squared correlation between a pair of SNPs, and \eqn{E[r^2]}{E[r^2]} is equa 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -68,3 +69,6 @@ Zbeta_log_rsq_over_expected(snps$bp_positions,3000,as.matrix(snps[,3:12]),snps$c \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +} diff --git a/man/Zbeta_rsq_over_expected.Rd b/man/Zbeta_rsq_over_expected.Rd index 6fc3ef90e91d59c4fc94c743beba639b27ed3899..10f250a698537336ad8a16256cb97b2e0e7e8be7 100644 --- a/man/Zbeta_rsq_over_expected.Rd +++ b/man/Zbeta_rsq_over_expected.Rd @@ -51,7 +51,8 @@ the squared correlation between a pair of SNPs, and \eqn{E[r^2]}{E[r^2]} is equa 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. +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 \code{\link{create_LDprofile}} function for more information on how to create an LD profile. } \examples{ ## load the snps and LDprofile example datasets @@ -68,3 +69,6 @@ Zbeta_rsq_over_expected(snps$bp_positions,3000,as.matrix(snps[,3:12]),snps$cM_di \references{ Jacobs, G.S., T.J. Sluckin, and T. Kivisild, \emph{Refining the Use of Linkage Disequilibrium as a Robust Signature of Selective Sweeps.} Genetics, 2016. \strong{203}(4): p. 1807 } +\seealso{ +\code{\link{create_LDprofile}} +}