Updated documentation (#24)

This commit is contained in:
Waldir Leoncio 2024-04-08 13:29:03 +02:00
parent 6209bb33fa
commit f676042a17
7 changed files with 24 additions and 9 deletions

View file

@ -19,8 +19,8 @@
#' with high-throughput sequencing data. <http://www.htslib.org/>
#' @export
#' @examples
#' data <- system.file("extdata", "FASTA_clustering_haploid.fasta", package = "rBAPS")
#' greedyMix(data, "fasta")
#' data <- system.file("extdata", "BAPS_format_clustering_diploid.txt", package = "rBAPS")
#' greedyMix(data, "baps")
greedyMix <- function(
data, format = gsub("^.*\\.", "", data), partitionCompare = NULL, npops = 1L,
counts = NULL, sumcounts = NULL, max_iter = 100L, alleleCodes = NULL,

View file

@ -1,7 +1,6 @@
#' @title Logml to string
#' @description Returns a string representation of a logml
#' @param logml input Logml
#' @param
#' @param leading_zeros_replacement string to replace leading zeros with
#' @return String version of logml
logml2String <- function(logml, leading_zeros_replacement = " ") {

View file

@ -1,6 +1,5 @@
#' @title Bayesian Analysis of Population Structure
#' @description This is a partial implementation of the BAPS software
#' @docType package
#' @name rBAPS
#' @note Found a bug? Want to suggest a feature? Contribute to the scientific
#' and open source communities by opening an issue on our home page.
@ -11,4 +10,5 @@
#' @importFrom stats runif
#' @importFrom zeallot %<-%
#' @importFrom matlab2r nargin log2
NULL
#' @importFrom utils read.table
"_PACKAGE"