cleaning - fix getSimilarDaysIndices ; to finish

[talweg.git] / pkg / R / utils.R

diff --git a/pkg/R/utils.R b/pkg/R/utils.R
index 3777f2d..20f396b 100644 (file)
--- a/pkg/R/utils.R
+++ b/pkg/R/utils.R
@@ -1,6 +1,6 @@
-#' @title dateIndexToInteger
+#' dateIndexToInteger
 #'
-#' @description Transform a (potential) date index into an integer (relative to data)
+#' Transform a (potential) date index into an integer (relative to data)
 #'
 #' @param index Date (or integer) index
 #' @param data Object of class \code{Data}
@@ -8,32 +8,28 @@
 #' @export
 dateIndexToInteger = function(index, data)
 {
-       index = index[1]
+       #works on integers too: trust input
        if (is.numeric(index))
                index = as.integer(index)
        if (is.integer(index))
                return (index)
+
        if (inherits(index, "Date") || is.character(index))
        {
-               tryCatch(dt <- as.POSIXct(index), error=function(e) stop("Unrecognized index format"))
+               tryCatch(indexAsDate <- as.Date(index), error=function(e) stop("Unrecognized index format"))
                #TODO: tz arg to difftime ?
-               integerIndex <- round( (as.numeric( difftime(dt, data$getTime(1)) ))[1] ) + 1
-               if (integerIndex > 0 && integerIndex <= data$getSize())
-               {
-                       #WARNING: if series start at date >0h, result must be shifted
-                       date1 = as.POSIXlt(data$getTime(1)[1])
-                       date2 = as.POSIXlt(data$getTime(2)[1])
-                       shift = (date1$year==date2$year && date1$mon==date2$mon && date1$mday==date2$mday)
-                       return (integerIndex + ifelse(shift,1,0))
-               }
+               integerIndex <- round( as.numeric(
+                       difftime(indexAsDate, as.Date(data$getTime(1)[1])) ) ) + 1
+               if (integerIndex >= 1 && integerIndex <= data$getSize())
+                       return (integerIndex)
                stop("Date outside data range")
        }
        stop("Unrecognized index format")
 }
 
-#' @title integerIndexToDate
+#' integerIndexToDate
 #'
-#' @description Transform an integer index to date index (relative to data)
+#' Transform an integer index to date index (relative to data)
 #'
 #' @param index Date (or integer) index
 #' @param data Object of class \code{Data}
@@ -41,28 +37,35 @@ dateIndexToInteger = function(index, data)
 #' @export
 integerIndexToDate = function(index, data)
 {
+       #works on dates too: trust input
+       if (is.character(index))
+               index = as.Date(index)
+       if (is(index,"Date"))
+               return (index)
+
        index = index[1]
        if (is.numeric(index))
                index = as.integer(index)
        if (!is.integer(index))
-               stop("'index' should be an integer")
+               stop("'index' should be a date or integer")
        as.Date( data$getTime(index)[1] )
 }
 
-#' @title getSimilarDaysIndices
+#' getSimilarDaysIndices
 #'
-#' @description Find similar days indices in the past
+#' Find similar days indices in the past.
 #'
 #' @param index Day index (numeric or date)
 #' @param limit Maximum number of indices to return
-#' @param same_seaon Should the indices correspond to day in same season?
+#' @param same_season Should the indices correspond to day in same season?
+#' @param data Dataset is required for a search in same season
 #'
 #' @export
-getSimilarDaysIndices = function(index, limit, same_season)
+getSimilarDaysIndices = function(index, limit, same_season, data=NULL)
 {
        index = dateIndexToInteger(index)
 
-       #TODO: mardi similaire à lundi mercredi jeudi aussi ...etc
+       #TODO: mardi similaire à lundi mercredi jeudi aussi ...etc ==> "isSimilarDay()..."
        if (!same_season)
        {
                #take all similar days in recent past
@@ -70,28 +73,48 @@ getSimilarDaysIndices = function(index, limit, same_season)
                return ( rep(index,nb_days) - 7*seq_len(nb_days) )
        }
 
-       #Look for similar days in similar season (+/- 30 days)
+       #Look for similar days in similar season
+       nb_days = min( (index-1) %/% 7, limit)
+       i = index - 7
        days = c()
-       i = index
+       month_ref = as.POSIXlt(data$getTime(index)[1])$mon + 1
        while (i >= 1 && length(days) < limit)
        {
-               if (i < index)
-               {
+               if (isSameSeason(as.POSIXlt(data$getTime(i)[1])$mon + 1, month_ref))
                        days = c(days, i)
-                       #look in the "future of the past"
-                       for (j in 1:4)
-                               days = c(days, i+7*j)
-               }
-               #...and in the "past of the past"
-               for (j in 1:4)
-               {
-                       if (i - 7*j >= 1)
-                               days = c(days, i-7*j)
-               }
-               # TODO: exact computation instead of -364
-               # 364 = closest multiple of 7 to 365 - drift along the years... but not so many years so OK
-               i = i - 364
+               i = i-7
        }
+       return ( days )
+}
+
+#TODO: use data... 12-12-1-2 CH, 3-4-9-10 EP et le reste NP
+isSameSeason = function(month, month_ref)
+{
+       if (month_ref %in% c(11,12,1,2))
+               return (month %in% c(11,12,1,2))
+       if (month_ref %in% c(3,4,9,10))
+               return (month %in% c(3,4,9,10))
+       return (month %in% c(5,6,7,8))
+}
+
+#TODO:
+#distinction lun-jeudi, puis ven, sam, dim
+#isSameDay = function(day, day_ref)
+#{
+#      if (day_ref == 
 
-       return ( days[1:min(limit,length(days))] )
+#' getNoNA2
+#'
+#' Get indices in data of no-NA series followed by no-NA, within [first,last] range.
+#'
+#' @param data Object of class Data
+#' @param first First index (included)
+#' @param last Last index (included)
+#'
+#' @export
+getNoNA2 = function(data, first, last)
+{
+       (first:last)[ sapply(first:last, function(i)
+               !any( is.na(data$getCenteredSerie(i)) | is.na(data$getCenteredSerie(i+1)) )
+       ) ]
 }