R/cv.R

In jlthomps/EflowStats: Returns HIT/HAT Hydrologic Indicator stats for a given set of data

#' Function to return the coefficient of variation for a given data series
#' 
#' This function accepts a data frame containing daily data and returns the coefficient of variation
#' 
#' @param x data frame containing value data for the chosen timeseries
#' @return cv coefficient of variation for the given data frame
#' @export
#' @examples
#' qfiletempf<-sampleData
#' cv(qfiletempf)
cv <- function(x) {
  x1 <- mean(x$discharge,na.rm=TRUE)
  x2 <- sdev(x)
  cv <- x2/x1
  return(cv)
}