R/gm_mean.R

In calebclass/NanoTube: An Easy Pipeline for NanoString nCounter Data Analysis

#' Calculate the geometric mean
#'
#' Calculates the geometric mean of a numeric vector
#'
#' @export
#' 
#' @param x A numeric vector
#' @param na.rm Logical (default TRUE). Should NA values be ignored in this 
#' calculation? If FALSE, a vector containing NA values will return a 
#' geometric mean of NA.
#' @return The geometric mean
#' 
#' @examples
#' gm_mean(c(1, 3, 5))

gm_mean = function(x, na.rm=TRUE){
    exp(sum(log(x[x > 0]), na.rm=na.rm) / length(x))
}