Add documentation.

DESCRIPTION

@@ -22,9 +22,13 @@ Imports:
   vctrs,
   biomformat,
   Biostrings,
+  Biobase,
+  BiocGenerics,
+  gtools,
   ShortRead,
   dada2,
   decontam,
+  dplyr,
   microbiome,
   DESeq2,
   metagenomeSeq,
@@ -33,11 +37,11 @@ Imports:
   pairwiseAdonis,
   phyloseq,
   psadd,
-  DESeq2,
   VennDiagram,
   digest,
   futile.logger,
   ggplot2,
+  glue,
   grid,
   gridExtra,
   vegan,
@@ -48,9 +52,14 @@ Imports:
   taxa,
   rmarkdown,
   ranacapa,
+  reshape2,
+  doParallel,
+  foreach,
   DECIPHER,
   mixOmics,
-  venn
+  venn,
+  htmlwidgets,
+  scales
 Remotes:
   github::omegahat/XML,
   bioc::3.10/biomformat,
@@ -61,11 +70,11 @@ Remotes:
   bioc::3.10/metagenomeSeq,
   bioc::3.10/phyloseq,
   bioc::3.10/microbiome,
-  bioc::3.10/DESeq2,
   bioc::3.10/DECIPHER,
   bioc::3.10/mixOmics,
   github::pmartinezarbizu/pairwiseAdonis/pairwiseAdonis,
   github::cpauvert/psadd,
   github::gauravsk/ranacapa,
   github::grunwaldlab/metacoder,
-  github::mixOmicsTeam/mixOmics
+  github::mixOmicsTeam/mixOmics,
+  github::mikelove/DESeq2

R/ASVenn_fun.R

@@ -237,10 +237,10 @@ ASVenn_fun <- function(data = data, output = "./ASVenn/", rank = "ASV",
 #'
 #' @param TF list containing vectors to plot.
 #' @param mode = 1: length(TF)<=5, mode = 2 5<length(TF)<7
-#' @param TITRE
-#' @param output
-#' @param refseq1
-#' @param alltax
+#' @param TITRE Plot title.
+#' @param output Output path.
+#' @param refseq1 Reference sequences.
+#' @param alltax Taxonomy table.
 #'
 #'
 #' @return Exports a venn diagram with corresponding tabulated file.

R/aggregate_fun.R

@@ -12,6 +12,7 @@
 #' @param verbose Verbose level. (1: quiet, 3: verbal)
 #' @param rank Taxonomy rank to merge features that have same taxonomy at a certain taxonomic rank (among rank_names(data), or 'ASV' for no glom)
 #' @param comp Comparison to test. Comma separated and comparisons are informed with a tilde (A~C,A~B,B~C). If empty, test all combination.
+#' @param returnval Boolean for function to return values.
 #'
 #' @return Export final CSV files, barplot with top significant ASV and Venn Digramm.
 #'

R/bars_fun.R

@@ -41,6 +41,7 @@ rarefaction <- function(data = data, col = NULL, step = 100, ggplotly = TRUE){
 #' @param Fact1 Variable used to change X axis tick labels and color (when split = FALSE)
 #' @param split if TRUE make a facet_wrap like grouped by Ord1 (default FALSE)
 #' @param relative Plot relative (TRUE, default) or raw abundance plot (FALSE)
+#' @param outfile Output html file.
 #'
 #' @return Returns barplots in an interactive plotly community plot
 #'

R/core_soft.R

@@ -7,6 +7,7 @@
 #' @param group Choose which level of the factor, if NULL generate a list for each level.
 #' @param freq frequence threshold of microbiome::core_members function
 #' @param prev prevalence threshold of microbiome::core_members function
+#' @param rank Taxonomy rank.
 #'
 #' @importFrom microbiome transform core_members
 #'

R/csv2phyloseq_fun.R

@@ -5,6 +5,7 @@
 #' @param taxtable Tabulated taxonomy table file path.
 #' @param seq Tabulated sequence file path.
 #' @param metadata Tabulated metadata file path.
+#' @param generateTree Boolean to generate the phylogenetic tree.
 #' @param output Output directory
 #' @param returnval Boolean to return values in console or not.
 #'

R/dada2_fun.R

@@ -5,7 +5,7 @@
 #' @param amplicon Choose amplipcon "16S" or "ITS"
 #' @param path Read files folder path
 #' @param outpath output .Rdata file name
-#' @param pool option for dada function (FALSE, TRUE or "pseudo"), default is "pseudo". See ? dada.
+#' @param dadapool option for dada function (FALSE, TRUE or "pseudo"), default is "pseudo". See ? dada.
 #' @param f_trunclen Forward read tuncate length (only for paired end 16S)
 #' @param r_trunclen Reverse read tuncate length (only for paired end 16S)
 #' @param f_primer Forward primer sequence (only for ITS)

R/export_to_stamp_fun.R

@@ -4,7 +4,7 @@
 #'
 #' @param data a phyloseq object (output from decontam or generate_phyloseq)
 #' @param output Output directory
-#' @param correc If TRUE, correct metadata to replace most common special characters (eg. é -> e), save the new file in meta_stampOK.tsv.
+#' @param correc If TRUE, correct metadata to replace most common special characters, save the new file in meta_stampOK.tsv.
 #'
 #' @return Export 2 text files ready to use with STAMP.
 #'

R/generate_phyloseq_fun.R

@@ -3,7 +3,7 @@
 #'
 #'
 #' @param dada_res Results of dada2_fun()
-#' @param taxtable Results of assign_taxo_fun()
+#' @param tax.table Results of assign_taxo_fun()
 #' @param tree Results of generate_tree_fun()
 #' @param metadata Path of metadata file (tab separated with header)
 #' @param output Output directory

R/generate_tree_fun.R

@@ -3,7 +3,9 @@
 #'
 #'
 #' @param dada_res Results of dada2_fun()
-#' @param output Output directory
+#' @param output Output directory.
+#' @param psobj Phyloseq object with sequences.
+#' @param verbose Verbosity level.
 #' @param returnval Boolean to return values in console or not.
 #'
 #' @return Return a formatted tree object ready to use in phyloseq.

R/idtaxaDB_formatting_functions.R

@@ -136,8 +136,8 @@ check_tax_fun <- function(taxtable = taxtable, output = NULL, rank = 7, verbose=
 #' @param taxtable data.frame
 #' @param seqs path to fasta file or readDNAStringSet
 #' @param prunedb maximum number of sequences per unique taxa.
-#' @param outputDIR
-#' @output
+#' @param outputDIR Output directory.
+
 
 #' @return List with taxonomy table and corresponding sequences.
 #'

R/idtaxa_assign_fun.R

@@ -6,6 +6,7 @@
 #' @param dna A ‘DNAStringSet’ of unaligned sequences.
 #' @param asv_names sequences IDs in same order.
 #' @param confidence Bootstrap threshold 0...100
+#' @param ncpu Number of cpu to use
 #'
 #' @return return taxonomic assignment of given sequences.
 #' @import futile.logger
@@ -14,10 +15,10 @@
 #' @export
 
 
-idTaxa_assign = function(db_file, dna, asv_names, confidence){
+idTaxa_assign = function(db_file, dna, asv_names, confidence, ncpu = NULLS){
   flog.info(paste('Using database ',db_file,sep=''))
   toto <- load(db_file)
-  ids <- IdTaxa(dna, trainingSet, strand="both", processors=NULL, verbose=TRUE)
+  ids <- IdTaxa(dna, trainingSet, strand="both", processors=ncpu, verbose=TRUE)
   names(ids) <- asv_names
   flog.info("Confidence filtering...")
   IDCONF = as.numeric(confidence)

R/phy2cyto_fun.R

@@ -97,12 +97,12 @@ phy2cyto_fun <- function(data = data, output = "./cytoscape/", column1 = NULL, r
           LINKS = cbind(rep(asv, length(srcs)), glue("type_{srcs}"), srcs)
         }
       } else{
-        #sinon partage et création d'un lien pour chaque environnement source.
+        #sinon partage et creation d'un lien pour chaque environnement source.
         LINKS = NULL
         for(rep in reps){
           sdat3 = sdat2[sdat2[,repl]==rep,]
           srcs = as.character(unique(sdat3[,column1]))
-          # Lien seulement si l'asv présent dans même sample à 2 environnements ou plus
+          # Lien seulement si l'asv present dans meme sample a 2 environnements ou plus
           if(length(srcs)>1){
             link = cbind(rep(asv, length(srcs)), glue("type_{srcs}"), srcs)
             # print(glue("{rep} {srcs} envs"))

R/subset_fastx.R

 #' subset_fastx
 #'
-#' Allows subset fastq or fasta files at a given threshold. This fonction can convert fastq to fasta.
+#' Allows subset fastq or fasta files at a given threshold. This function can convert fastq to fasta.
 #'
 #' @param path Path to the fastq files directory
 #' @param format fasta or fastq format are allowed.
@@ -36,7 +36,7 @@ subset_fastx <- function(path = NULL, format = "fastq", outformat = "fastq", out
       writeXStringSet(X, glue::glue("{output}/{L2[i]}.{outformat}"), format = outformat, compress=compress)
       return("Done")
     }
-    
+
     if(length(X)>nbseq){
       if(random){
         if(!is.null(seed)){set.seed(seed)}

man/VENNFUN.Rd

@@ -18,7 +18,13 @@ VENNFUN(
 
 \item{mode}{= 1: length(TF)<=5, mode = 2 5<length(TF)<7}
 
-\item{alltax}{}
+\item{TITRE}{Plot title.}
+
+\item{output}{Output path.}
+
+\item{refseq1}{Reference sequences.}
+
+\item{alltax}{Taxonomy table.}
 }
 \value{
 Exports a venn diagram with corresponding tabulated file.

man/aggregate_fun.Rd

@@ -38,6 +38,8 @@ aggregate_fun(
 \item{rank}{Taxonomy rank to merge features that have same taxonomy at a certain taxonomic rank (among rank_names(data), or 'ASV' for no glom)}
 
 \item{comp}{Comparison to test. Comma separated and comparisons are informed with a tilde (A~C,A~B,B~C). If empty, test all combination.}
+
+\item{returnval}{Boolean for function to return values.}
 }
 \value{
 Export final CSV files, barplot with top significant ASV and Venn Digramm.

man/assign_taxo_fun.Rd

@@ -10,7 +10,8 @@ assign_taxo_fun(
   id_db = "/PathToDB/UNITE_idtaxa.Rdata",
   confidence = 50,
   verbose = 1,
-  returnval = TRUE
+  returnval = TRUE,
+  ncpu = NULL
 )
 }
 \arguments{
@@ -25,6 +26,8 @@ assign_taxo_fun(
 \item{verbose}{Verbose level. (1: quiet, 3: verbal)}
 
 \item{returnval}{Boolean to return values in console or not.}
+
+\item{ncpu}{Number of cpus to use.}
 }
 \value{
 Return a taxonomy table with multiple ancestor checking and incongruence checking when 2 databases are used.

man/bars_fun.Rd

@@ -29,6 +29,8 @@ bars_fun(
 \item{split}{if TRUE make a facet_wrap like grouped by Ord1 (default FALSE)}
 
 \item{relative}{Plot relative (TRUE, default) or raw abundance plot (FALSE)}
+
+\item{outfile}{Output html file.}
 }
 \value{
 Returns barplots in an interactive plotly community plot

man/core_soft_fun.Rd

@@ -23,6 +23,8 @@ core_soft_fun(
 \item{freq}{frequence threshold of microbiome::core_members function}
 
 \item{prev}{prevalence threshold of microbiome::core_members function}
+
+\item{rank}{Taxonomy rank.}
 }
 \description{
 Define core microbiome, soft micriome and transitory microbiome.

man/csv2phyloseq_fun.Rd

@@ -23,6 +23,8 @@ csv2phyloseq_fun(
 
 \item{metadata}{Tabulated metadata file path.}
 
+\item{generateTree}{Boolean to generate the phylogenetic tree.}
+
 \item{output}{Output directory}
 
 \item{returnval}{Boolean to return values in console or not.}