R/geocv.R

In philsf/philsfmisc: philsf's miscellaneous R functions

#' Compute the CV of log-normally distributed data.
#'
#' \code{geocv} computes the CV of log-normal data.
#'
#' This function first log10-transforms the original data \code{x}.
#' It then passes the standard deviation of the result to \code{logsd2cv}.
#'
#' @param x A numeric value, vector or list.
#' @param na.rm (logical) whether or not to remove \code{NA} values from computation
#'
#' @return Returns the geometric CV (as percentage)
#'
#' @examples
#' d <- c(10,100,1000)
#' geocv(d)
#' geocv(d) == logsd2cv(1)
#'
#' @author Felipe Figueiredo
#' @export
#' @importFrom stats sd

geocv <- function(x, na.rm = TRUE) {
  logsd <- sd(log10(x), na.rm = na.rm)
  logsd2cv(logsd)
}