R/qx.R

In renatoinomata/hidrowebr: hidrowebr: uma ferramenta para análise estatística de séries hidrológicas

#' Função de vazões médias em dias consecutivos
#'
#' @description Calcula a média das vazões a cada \code{x} dias consecutivos.
#'
#' @param dados Data frame obtida após o uso da função \code{\link{organizar}}
#' @param x Número de dias consecutivos. O valor padrão é 7, correspondendo a
#'   série de vazões Q7.
#'
#' @return A função retorna uma data frame com as colunas de \code{Est},
#'   \code{Data} e \code{Qx}. A média só será realizada caso existam \code{x}
#'   dias consecutivos.
#'
#' @examples
#' # Cálculo das Q7:
#' qx(fluviopolis)
#'
#' # Cálculo de Q15:
#' qx(fluviopolis, x = 15)
#'
#' @export
qx <- function(dados, x = 7){
  est <- unique(dados$Est)
  dadosQx <- data.frame()
  for (i in est){
    auxEst <- dplyr::filter(dados, Est == i)
    periodo <- seq(min(auxEst$Data), max(auxEst$Data), by = "days")
    aux <- data.frame(i, periodo)
    aux$Q <- NA
    colnames(aux) <- c("Est", "Data", "Q")
    aux <- rbind(auxEst, aux)
    aux <- aux[!duplicated(aux$Data), ]
    aux <- dplyr::arrange(aux, Data)
    aux$Qx <- zoo::rollapply(aux$Q, x, mean,  fill = NA, align = "right")
    aux$Q <- NULL
    aux <- aux[!is.na(aux$Qx), ]
    dadosQx <- rbind(dadosQx, aux)
  }
  return(dadosQx)
}