R/microbiomics-package.r

#' Microbiomics
#' 
#' Implementation of some functions that may come handy in analysing microbiome data. 
#' 
#' The microbiomics package is developed at GitHub (\url{https://github.com/tvatanen/microbiomics/}).
#'
#' Following functions are included:
#' \describe{
#'  \item{\code{\link{read_metaphlan_table}}}{read a MetaPhlAn 2.0 output file as an R data frame}
#'  \item{\code{\link{jaccard}}}{compute Jaccard distance/index between given microbial profiles}
#'  \item{\code{\link{read_taxon_table}}}{read a summarize_taxa.py output file as an R data frame}
#'  \item{\code{\link{pairwise_spearman}}}{compute pairwise correlations between columns of two data sets}
#'  \item{\code{\link{get_significant_values}}}{get significant components among a matrix of measurements}
#'  \item{\code{\link{Maaslin.wrapper}}}{run MaAsLin (\url{https://bitbucket.org/biobakery/maaslin/}) given a
#' set of taxa and metadata}
#'  \item{\code{\link{Maaslin2.wrapper}}}{run MaAsLin2 (\url{https://bitbucket.org/biobakery/maaslin2/}) given a
#' set of taxa and metadata}
#' }
#' 
#' @import pspearman
#' @import magrittr
#' @import stringr
#' @import tibble
#' @import readr
#' 
#' @docType package
#' @name microbiomics-package
NULL
#> NULL
tvatanen/microbiomics documentation built on Sept. 27, 2019, 7:29 a.m.