R/core.R

In microbiome/microbiome: Microbiome Analytics

#' @title Core Microbiota
#' @description Filter the phyloseq object to include only prevalent taxa.
#' @param x \code{\link{phyloseq-class}} object
#' @param detection Detection threshold for absence/presence
#' (strictly greater by default).
#' @param prevalence Prevalence threshold (in [0, 1]). The
#' required prevalence is strictly greater by default. To include the
#' limit, set include.lowest to TRUE. 
#' @param include.lowest Include the lower boundary of the detection and
#' prevalence cutoffs. FALSE by default.
#' @param ... Arguments to pass.
#' @return Filtered phyloseq object including only prevalent taxa
#' @references
#' Salonen A, Salojarvi J, Lahti L, de Vos WM. The adult intestinal
#' core microbiota is determined by analysis depth and health
#' status. Clinical Microbiology and Infection 18(S4):16-20, 2012
#' To cite the microbiome R package, see citation('microbiome') 
#' @author Contact: Leo Lahti \email{microbiome-admin@@googlegroups.com}
#' @keywords utilities
#' @export
#' @seealso core_members, rare_members
#' @aliases filter_prevalent
#' @examples
#' data(dietswap)
#' # Detection threshold 0 (strictly greater by default);
#' # Prevalence threshold 50 percent (strictly greater by default)
#' pseq <- core(dietswap, 0, 50/100)
#' # Detection threshold 0 (strictly greater by default);
#' # Prevalence threshold exactly 100 percent; for this set
#' # include.lowest=TRUE, otherwise the required prevalence is 
#' # strictly greater than 100
#' pseq <- core(dietswap, 0, 100/100, include.lowest = TRUE)
core <- function(x, detection, prevalence, include.lowest=FALSE, ...) {
    
    xorig <- x
    
    # TODO: add optional renormalization such that the core member
    # abundances would
    # sum up to 1 ?
    taxa <- core_members(x, detection, prevalence,
        include.lowest=include.lowest)

    prune_taxa(taxa, xorig)

}