R/groupedStouffer.R

In LTLA/metapod: Meta-Analyses on P-Values of Differential Analyses

#' Combine grouped p-values with Stouffer's Z-score method
#'
#' Combine p-values from grouped tests with Stouffer's Z-score method.
#' Groups are defined according to unique levels of a grouping factor.
#'
#' @inheritParams groupedSimes
#'
#' @return A list containing:
#' \itemize{
#' \item \code{p.value}, a named numeric vector of length equal to the number of unique levels in \code{grouping}.
#' This contains the combined p-value for each group, log-transformed if \code{log.p=TRUE}.
#' Each entry is named according to the group.
#' \item \code{representative}, a named integer scalar specifying the representative test for each group.
#' Each entry is named according to the group.
#' \item \code{influential}, a logical vector of length equal to \code{p.values}.
#' Entries are \code{TRUE} for any p-value that is deemed \dQuote{influential} to the final combined p-value for its group.
#' }
#'
#' @inherit parallelStouffer details
#' @inherit parallelStouffer references
#' 
#' @author Aaron Lun
#' @examples
#' p1 <- rbeta(100, 0.8, 1)
#' g <- sample(10, length(p1), replace=TRUE)
#'
#' # Standard application:
#' out <- groupedStouffer(p1, g)
#' str(out)
#'
#' # With weights:
#' out <- groupedStouffer(p1, g, weights=rexp(length(p1)))
#' str(out)
#' 
#' # With log p-values. 
#' out <- groupedStouffer(log(p1), g, log.p=TRUE)
#' str(out)
#'
#' @seealso
#' \code{\link{parallelStouffer}}, for a version that operates on parallel vectors of p-values.
#'
#' \code{\link{groupedFisher}} and \code{\link{groupedPearson}}, for different approaches to testing a joint null of independent hypotheses.
#' @export
groupedStouffer <- function(p.values, grouping, weights=NULL, log.p=FALSE) {
    .grouped_compute(p.values, grouping, weights, log.p=log.p, FUN=compute_grouped_stouffer)
}