X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2Futils.R;h=80a7e5df1e2774fbd54217044ef862ccc0d09c07;hb=a66a84b56467194852f2faee15f4725759b24158;hp=de8e861cb5c02ab5e0e2c1bc2f26f527b1c34589;hpb=44a9990b6d608ffcd2e99d5193fa8b9e6cbdb436;p=talweg.git

diff --git a/pkg/R/utils.R b/pkg/R/utils.R
index de8e861..80a7e5d 100644
--- 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,11 +8,10 @@
 #' @export
 dateIndexToInteger = function(index, data)
 {
-	index = index[1]
 	if (is.numeric(index))
 		index = as.integer(index)
 	if (is.integer(index))
-		return (index)
+		return (index) #works on integers too: trust input
 	if (inherits(index, "Date") || is.character(index))
 	{
 		tryCatch(indexAsDate <- as.Date(index), error=function(e) stop("Unrecognized index format"))
@@ -20,26 +19,15 @@ dateIndexToInteger = function(index, data)
 		integerIndex <- round( as.numeric(
 			difftime(indexAsDate, as.Date(data$getTime(1)[1])) ) ) + 1
 		if (integerIndex >= 1 && integerIndex <= data$getSize())
-		{
-			#WARNING: if index>=2 && series start at date >0h, result must be shifted
-			#Convention: if first date asked, return first matching index (i.e.: 1)
-			shift = 0
-			if (integerIndex >= 2)
-			{
-				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 + shift)
-		}
+			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}
@@ -47,17 +35,19 @@ dateIndexToInteger = function(index, data)
 #' @export
 integerIndexToDate = function(index, data)
 {
+	if (is(index,"Date"))
+		return (index) #works on dates too: trust input
 	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
@@ -101,3 +91,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