From 5279e277084103d0ca62d37c8f35b05379e423d1 Mon Sep 17 00:00:00 2001 From: Louis Aslett Date: Mon, 23 Sep 2024 16:47:30 +0100 Subject: [PATCH] Typo fix in documentation of rho --- DESCRIPTION | 2 +- R/Parameters.R | 2 +- man/CalcRho.Rd | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 21354e7..c71448f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -37,7 +37,7 @@ Imports: RColorBrewer, lobstr, prettyunits -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.2 Roxygen: list(markdown = TRUE) Suggests: rhdf5, diff --git a/R/Parameters.R b/R/Parameters.R index 272e483..bf40ca1 100644 --- a/R/Parameters.R +++ b/R/Parameters.R @@ -9,7 +9,7 @@ #' TODO: add kalis paper cross ref. #' See page 3 in Supplemental Information for the original ChromoPainter paper (Lawson et al., 2012) for motivation behind our parameterisation, which is as follows: #' -#' \deqn{\rho = \exp(-s \times cM^\gamma) - 1}{\rho = exp(-s * cM^\gamma) - 1} +#' \deqn{\rho = 1 - \exp(-s \times cM^\gamma)}{\rho = 1 - exp(-s * cM^\gamma)} #' #' #' @param cM a vector specifying the recombination distance between variants in centimorgans. diff --git a/man/CalcRho.Rd b/man/CalcRho.Rd index 060f0b1..3f87fbd 100644 --- a/man/CalcRho.Rd +++ b/man/CalcRho.Rd @@ -33,7 +33,7 @@ This is a utility function to calculate the recombination probabilities rho (the TODO: add kalis paper cross ref. See page 3 in Supplemental Information for the original ChromoPainter paper (Lawson et al., 2012) for motivation behind our parameterisation, which is as follows: -\deqn{\rho = \exp(-s \times cM^\gamma) - 1}{\rho = exp(-s * cM^\gamma) - 1} +\deqn{\rho = 1 - \exp(-s \times cM^\gamma)}{\rho = 1 - exp(-s * cM^\gamma)} } \examples{ # Load the mini example data and recombination map from the package built-in #' # dataset