intermediate: R6, too slow
[talweg.git] / pkg / R / utils.R
index 3777f2d..0918a32 100644 (file)
@@ -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}
@@ -15,25 +15,20 @@ dateIndexToInteger = function(index, data)
                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}
@@ -49,9 +44,9 @@ integerIndexToDate = function(index, data)
        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
@@ -95,3 +90,14 @@ getSimilarDaysIndices = function(index, limit, same_season)
 
        return ( days[1:min(limit,length(days))] )
 }
+
+#' getSerie
+#'
+#' Return a time-serie from its centered version + level
+#'
+#' @param data A list as returned by \code{getData}
+#' @param index The index to return
+#'
+#' @export
+getSerie = function(data, index)
+       data[[index]]$centered_serie + data[[index]]$level