SeriesAggreg.R

SeriesAggreg <- function(TabSeries,TimeFormat,NewTimeFormat,ConvertFun,YearFirstMonth=01, verbose = TRUE){


  ##_Arguments_check

    ##check_TabSeries
      if(is.null(TabSeries)       ){ stop("TabSeries must be a dataframe containing the dates and data to be converted \n"); return(NULL); }
      if(!is.data.frame(TabSeries)){ stop("TabSeries must be a dataframe containing the dates and data to be converted \n"); return(NULL); }
      if(ncol(TabSeries)<2){ stop("TabSeries must contain at least two columns (including the coulmn of dates \n"); return(NULL); }
      if("POSIXlt" %in% class(TabSeries[,1]) == FALSE & "POSIXct" %in% class(TabSeries[,1]) == FALSE){ stop("TabSeries first column must be a vector of class POSIXlt or POSIXct \n"); return(NULL); }
      for(iCol in 2:ncol(TabSeries)){
      if(!is.numeric(TabSeries[,iCol])){ stop("TabSeries columns (other than the first one) be of numeric class \n"); return(NULL); }  }
    ##check_TimeFormat
      if(is.null(      TimeFormat)){ stop("TimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
      if(!is.vector(   TimeFormat)){ stop("TimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
      if(!is.character(TimeFormat)){ stop("TimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
      if(length(TimeFormat)!=1    ){ stop("TimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
      if(TimeFormat %in% c("hourly","daily","monthly","yearly")==FALSE){
                                    stop("TimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
    ##check_NewTimeFormat
      if(is.null(      NewTimeFormat)){ stop("NewTimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
      if(!is.vector(   NewTimeFormat)){ stop("NewTimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
      if(!is.character(NewTimeFormat)){ stop("NewTimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
      if(length(NewTimeFormat)!=1    ){ stop("NewTimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
      if(NewTimeFormat %in% c("hourly","daily","monthly","yearly")==FALSE){
                                    stop("NewTimeFormat must be 'hourly', 'daily', 'monthly' or 'yearly' \n"); return(NULL); } 
    ##check_ConvertFun
      if(is.null(      ConvertFun)){ stop("ConvertFun must be a vector of character \n"); return(NULL); } 
      if(!is.vector(   ConvertFun)){ stop("ConvertFun must be a vector of character \n"); return(NULL); } 
      if(!is.character(ConvertFun)){ stop("ConvertFun must be a vector of character \n"); return(NULL); } 
      if(length(ConvertFun)!=(ncol(TabSeries)-1)){ stop(paste("ConvertFun must be of length ",ncol(TabSeries)-1," (length=ncol(TabSeries)-1) \n",sep="")); return(NULL); } 
      if(sum(ConvertFun %in% c("sum","mean")==FALSE)!=0){ stop("ConvertFun elements must be either 'sum' or 'mean' \n"); return(NULL); } 
    ##check_YearFirstMonth
      if(is.null(    YearFirstMonth)){ stop("YearFirstMonth must be an integer between 1 and 12 \n"); return(NULL); } 
      if(!is.vector( YearFirstMonth)){ stop("YearFirstMonth must be an integer between 1 and 12 \n"); return(NULL); } 
      if(!is.numeric(YearFirstMonth)){ stop("YearFirstMonth must be an integer between 1 and 12 \n"); return(NULL); } 
      YearFirstMonth <- as.integer(YearFirstMonth);
      if(length(YearFirstMonth)!=1){ stop(paste("YearFirstMonth must be only one integer between 1 and 12 \n",sep="")); return(NULL); } 
      if(YearFirstMonth %in% (1:12) == FALSE){ stop(paste("YearFirstMonth must be only one integer between 1 and 12 \n",sep="")); return(NULL); } 
    ##check_DatesR_integrity
      if(TimeFormat=="hourly" ){ by <- "hours" ; }
      if(TimeFormat=="daily"  ){ by <- "days"  ; }
      if(TimeFormat=="monthly"){ by <- "months"; }
      if(TimeFormat=="yearly" ){ by <- "years" ; }
      TmpDatesR <- seq(from=TabSeries[1,1],to=tail(TabSeries[,1],1),by=by)
      if(!identical(TabSeries[,1],TmpDatesR)){ stop("Problem detected in TabSeries dates vector (in comparison with seq(from=TabSeries[1,1],to=tail(TabSeries[,1],1))) \n"); return(NULL); }
    ##check_conversion_direction
      if((TimeFormat == "daily"   & NewTimeFormat %in% c("hourly")                  ) |
         (TimeFormat == "monthly" & NewTimeFormat %in% c("hourly","daily")          ) |
         (TimeFormat == "yearly"  & NewTimeFormat %in% c("hourly","daily","monthly"))){ 
           stop("only time aggregation can be performed \n"); return(NULL); } 
    ##check_if_conversion_not_needed
      if((TimeFormat == "hourly"  & NewTimeFormat=="hourly" ) |
         (TimeFormat == "daily"   & NewTimeFormat=="daily"  ) |
         (TimeFormat == "monthly" & NewTimeFormat=="monthly") |
         (TimeFormat == "yearly"  & NewTimeFormat=="yearly" )){ 
           if(verbose){ warning("\t The old and new format are identical \n\t -> no time-step conversion was performed \n"); return(TabSeries); } }


  ##_Time_step_conversion

    ##_Handle_conventional_difference_between_hourly_series_and_others
      TmpDatesR <- TabSeries[,1];
      if(TimeFormat=="hourly"){ TmpDatesR <- TmpDatesR - 60*60; }
      Hmax <- "00"; if(TimeFormat=="hourly"){ Hmax <- "23" }

    ##_Identify_the_part_of_the_series_to_be_aggregated
      NDaysInMonth <- list("31",c("28","29"),"31","30","31","30","31","31","30","31","30","31")
      YearLastMonth <- YearFirstMonth+11; if(YearLastMonth>12){ YearLastMonth <- YearLastMonth-12; }
      YearFirstMonthTxt <- formatC(YearFirstMonth,format="d",width=2,flag="0")