R/precintcon.max.r

In lucasvenez/precintcon: Precipitation Intensity, Concentration and Anomaly Analysis

#' @noRd
#' @name precintcon.max
#' @author Lucas Venezian Povoa \email{lucasvenez@@gmail.com} 
#' @aliases precintcon.max 
#' @title Maximun precipitation 
#' @description Calculate the max precipitation and its related date into the serie. 
#' @usage precintcon.max(object) 
#' @param object a daily or monthly precipitation serie.
#' @return An array containing the following values:
#' \enumerate{
#' \item the maximun precipitation into the serie.
#' \item the date of the first ocorrence of the max precipitation into the serie.
#' } 
#' @seealso \code{\link{precintcon.limits.analysis}} 
#' @keywords precipitation limits max 
precintcon.max <- function(object) {
	
	if (is.element("precintcon.daily", class(object))) {
		
		m <- max(as.matrix(object[,3:33]), na.rm=T)

		i <- which(object == m, arr.ind=T)
		
		d <- paste(i[1,2] - 2, object[i[1,1], 2], object[i[1,1], 1], sep="/")
		
		return(c(m, d))
		
	} else if (is.element("precintcon.monthly", class(object))) {
		
		m <- max(object[,3], na.rm=T)
		
		i <- which(object[,3] == m)
		
		d <- paste(object[i[1],2], object[i[1],1], sep="/")
		
		return(c(m, d))		
	
	} else
		stop("Invalid object type. It should be an precintcon.daily or precintcon.monthly object.")
};