Skip to content

Commit

Permalink
Fixed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wleoncio committed Sep 11, 2023
1 parent 882fcd4 commit 70ec460
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 16 deletions.
1 change: 0 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
export(greedyMix)
export(handleData)
export(importFile)
export(load_fasta)
importFrom(R6,R6Class)
importFrom(Rsamtools,scanBam)
importFrom(adegenet,.readExt)
Expand Down
4 changes: 0 additions & 4 deletions R/greedyMix.R
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@
#' @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
Expand Down
5 changes: 3 additions & 2 deletions R/load_fasta.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,17 @@
#'
#' @param msa Either the location of a fasta file or ape DNAbin object containing the multiple sequence alignment data to be clustered
#' @param keep_singletons A logical indicating whether to consider singleton mutations in calculating the clusters
#' @param output_numbers A logical indicating whether to output the data as
#' numbers (TRUE) or letters (FALSE)
#'
#' @return A character matrix with filtered SNP data
#'
#' @examples
#' msa <- system.file("extdata", "seqs.fa", package = "rBAPS")
#' snp.matrix <- load_fasta(msa)
#' snp.matrix <- rBAPS:::load_fasta(msa)
#' @author Gerry Tonkin-Hill, Waldir Leoncio
#' @seealso rhierbaps::load_fasta
#' @importFrom ape read.FASTA as.DNAbin
#' @export
load_fasta <- function(msa, keep_singletons = FALSE, output_numbers = TRUE) {

# Check inputs
Expand Down
8 changes: 0 additions & 8 deletions man/greedyMix.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion man/load_fasta.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 70ec460

Please sign in to comment.