Fixed documentation for clean build

This commit is contained in:
Waldir Leoncio 2020-03-02 16:15:01 +01:00
parent 849288dfd3
commit 62598eaf0d
7 changed files with 39 additions and 3 deletions

View file

@ -2,4 +2,5 @@ LICENSE
TODO.md TODO.md
matlab matlab
CHANGELOG.md CHANGELOG.md
CITATION.cff CITATION.cff
.travis.yml

View file

@ -5,6 +5,9 @@
#' @param npops npops #' @param npops npops
#' @param rowsFromInd rowsFromInd #' @param rowsFromInd rowsFromInd
#' @param alaraja alaraja #' @param alaraja alaraja
#' @param PARTITION PARTITION
#' @param COUNTS COUNTS
#' @param SUMCOUNTS SUMCOUNTS
#' @export #' @export
poistaLiianPienet <- function (npops, rowsFromInd, alaraja, poistaLiianPienet <- function (npops, rowsFromInd, alaraja,
PARTITION = matrix(NA, 0, 0), COUNTS = matrix(NA, 0, 0), PARTITION = matrix(NA, 0, 0), COUNTS = matrix(NA, 0, 0),

View file

@ -1,6 +1,11 @@
#' @title Simulate individuals #' @title Simulate individuals
#' @description simulate n individuals from population pop, such that #' @description simulate n individuals from population pop, such that
#' proportion "missing_level" of the alleles are present. #' proportion "missing_level" of the alleles are present.
#' @param n n
#' @param rowsFromInd rowsFromInd
#' @param allfreqs allfreqs
#' @param pop pop
#' @param missing_level missing_level
#' @export #' @export
simulateIndividuals <- function(n, rowsFromInd, allfreqs, pop, missing_level) { simulateIndividuals <- function(n, rowsFromInd, allfreqs, pop, missing_level) {

View file

@ -1,6 +1,9 @@
#' @title simuloiAlleeli #' @title simuloiAlleeli
#' @description Simuloi populaation pop lokukseen loc alleelin. #' @description Simuloi populaation pop lokukseen loc alleelin.
#' @note This function is (only?) called by `simulateIndividuals()`. Therefore, exporting it is probably unnecessary. #' @note This function is (only?) called by `simulateIndividuals()`. Therefore, exporting it is probably unnecessary.
#' @param allfreqs allfreqa
#' @param pop pop
#' @param loc loc
#' @export #' @export
simuloiAlleeli <- function(allfreqs, pop, loc) { simuloiAlleeli <- function(allfreqs, pop, loc) {
@ -18,7 +21,7 @@ simuloiAlleeli <- function(allfreqs, pop, loc) {
# allfreqs[, loc], # allfreqs[, loc],
# allfreqs[, loc, pop] # allfreqs[, loc, pop]
# ) # )
cumsumma <- cumsum(freqs) cumsumma <- cumsum(freqs)
arvo <- runif(1) arvo <- runif(1)

View file

@ -19,6 +19,12 @@ poistaLiianPienet(
\item{rowsFromInd}{rowsFromInd} \item{rowsFromInd}{rowsFromInd}
\item{alaraja}{alaraja} \item{alaraja}{alaraja}
\item{PARTITION}{PARTITION}
\item{COUNTS}{COUNTS}
\item{SUMCOUNTS}{SUMCOUNTS}
} }
\description{ \description{
Muokkaa tulokset muotoon, jossa outlier yksilöt on poistettu. Muokkaa tulokset muotoon, jossa outlier yksilöt on poistettu.

View file

@ -6,6 +6,17 @@
\usage{ \usage{
simulateIndividuals(n, rowsFromInd, allfreqs, pop, missing_level) simulateIndividuals(n, rowsFromInd, allfreqs, pop, missing_level)
} }
\arguments{
\item{n}{n}
\item{rowsFromInd}{rowsFromInd}
\item{allfreqs}{allfreqs}
\item{pop}{pop}
\item{missing_level}{missing_level}
}
\description{ \description{
simulate n individuals from population pop, such that simulate n individuals from population pop, such that
proportion "missing_level" of the alleles are present. proportion "missing_level" of the alleles are present.

View file

@ -6,6 +6,13 @@
\usage{ \usage{
simuloiAlleeli(allfreqs, pop, loc) simuloiAlleeli(allfreqs, pop, loc)
} }
\arguments{
\item{allfreqs}{allfreqa}
\item{pop}{pop}
\item{loc}{loc}
}
\description{ \description{
Simuloi populaation pop lokukseen loc alleelin. Simuloi populaation pop lokukseen loc alleelin.
} }