From 8323d54c0176bc46c51a2faceddc3956b1eaa70a Mon Sep 17 00:00:00 2001 From: Waldir Leoncio Date: Tue, 25 Feb 2020 13:53:11 +0100 Subject: [PATCH] Improved documentation --- NAMESPACE | 1 + R/computeAllFreqs2.R | 4 ++++ man/computeAllFreqs2.Rd | 7 +++++++ tests/testthat/test-admix1.R | 2 +- 4 files changed, 13 insertions(+), 1 deletion(-) diff --git a/NAMESPACE b/NAMESPACE index 927db13..c80ce2b 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -3,6 +3,7 @@ export(admix1) export(calculatePopLogml) export(colon) +export(computeAllFreqs2) export(computeIndLogml) export(computePersonalAllFreqs) export(computeRows) diff --git a/R/computeAllFreqs2.R b/R/computeAllFreqs2.R index 290c41c..6ad2ca8 100644 --- a/R/computeAllFreqs2.R +++ b/R/computeAllFreqs2.R @@ -1,6 +1,10 @@ #' @title Compute all freqs - version 2 #' @description Lisää a priori jokaista alleelia joka populaation joka lokukseen #' j 1/noalle(j) verran. +#' @param noalle noalle +#' @param COUNTS counts +#' @param SUMCOUNTS sumcounts +#' @export computeAllFreqs2 <- function (noalle, COUNTS = matrix(NA, 0, 0), SUMCOUNTS = sum(COUNTS)) { diff --git a/man/computeAllFreqs2.Rd b/man/computeAllFreqs2.Rd index fcb125b..7bb8b04 100644 --- a/man/computeAllFreqs2.Rd +++ b/man/computeAllFreqs2.Rd @@ -6,6 +6,13 @@ \usage{ computeAllFreqs2(noalle, COUNTS = matrix(NA, 0, 0), SUMCOUNTS = sum(COUNTS)) } +\arguments{ +\item{noalle}{noalle} + +\item{COUNTS}{counts} + +\item{SUMCOUNTS}{sumcounts} +} \description{ Lisää a priori jokaista alleelia joka populaation joka lokukseen j 1/noalle(j) verran. diff --git a/tests/testthat/test-admix1.R b/tests/testthat/test-admix1.R index b5cd9e3..0be71f7 100644 --- a/tests/testthat/test-admix1.R +++ b/tests/testthat/test-admix1.R @@ -114,7 +114,7 @@ test_that("computeIndLogml works like on Matlab", { expect_equivalent(computeIndLogml(1, 0), -Inf) expect_equivalent(computeIndLogml(0, 0), -Inf) expect_equivalent(computeIndLogml(-pi, -8), 3.2242, tol = .0001) - expect_equivalent(computeIndLogml(2:3, 2), 2.3026, tol = .0001) + expect_equivalent(computeIndLogml(2:3, 2), 2.3026, tol = .0001) expect_equivalent(computeIndLogml(matrix(8:5, 2), 100), 14.316, tol = .001) expect_equivalent( object = computeIndLogml(matrix(8:5, 2), matrix(c(1, 3), 1)),