Added missing documentation for arguments (#25)

This commit is contained in:
Waldir Leoncio 2023-08-09 15:27:45 +02:00
parent 85c8c01816
commit bd932e2b6d
2 changed files with 57 additions and 11 deletions

View file

@ -1,6 +1,20 @@
#' @title Clustering of individuals
#' @param data data file
#' @param format Data format. Format supported: "FASTA", "VCF" ,"BAM", "GenePop"
#' @param partitionCompare a list of partitions to compare
#' @param ninds number of individuals
#' @param rowsFromInd a list of rows for each individual
#' @param noalle number of alleles
#' @param adjprior ajuster prior probabilities
#' @param npops number of populations
#' @param priorTerm prior terms
#' @param counts counts
#' @param sumcounts sumcounts
#' @param max_iter maximum number of iterations
#' @param alleleCodes allele codes
#' @param inp input file
#' @param popnames population names
#' @param fixedK if \code{TRUE}, the number of populations is fixed
#' @param verbose if \code{TRUE}, prints extra output information
#' @importFrom utils read.delim
#' @importFrom vcfR read.vcfR
@ -33,7 +47,7 @@ greedyMix <- function(
# Comparing partitions =======================================================
if (!is.null(partitionCompare)) {
logmls <- comparePartitions(
data, nrows(data), partitionCompare[["partitions"]], ninds, rowsFromInd,
data, nrow(data), partitionCompare[["partitions"]], ninds, rowsFromInd,
noalle, adjprior
)
}