X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2Futils.R;h=ddf0bb1dc6e0aa0c919222a917b50099d6a74a6a;hb=c36568faefc97bb417d355e2084398c1ad1acf92;hp=b3e66e18d109f9bd56ece2618f204422f2bd63a0;hpb=ee8b1b4e3c13f8dcf13a2c8da6a3bef1520c8252;p=talweg.git

diff --git a/pkg/R/utils.R b/pkg/R/utils.R
index b3e66e1..ddf0bb1 100644
--- a/pkg/R/utils.R
+++ b/pkg/R/utils.R
@@ -1,14 +1,14 @@
 #' dateIndexToInteger
 #'
-#' Transform a (potential) date index into an integer (relative to data)
+#' Transform a (potential) date index into an integer (relative to data beginning).
 #'
 #' @param index Date (or integer) index
-#' @param data Object of class \code{Data}
+#' @param data Object of class Data, output of \code{getData()}
 #'
 #' @export
 dateIndexToInteger = function(index, data)
 {
-	#works on integers too: trust input
+	# Works on integers too: trust input
 	if (is.numeric(index))
 		index = as.integer(index)
 	if (is.integer(index))
@@ -16,7 +16,8 @@ dateIndexToInteger = function(index, data)
 
 	if (inherits(index, "Date") || is.character(index))
 	{
-		tryCatch(indexAsDate <- as.Date(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(indexAsDate, as.Date(data$getTime(1)[1])) ) ) + 1
@@ -29,15 +30,14 @@ dateIndexToInteger = function(index, data)
 
 #' integerIndexToDate
 #'
-#' Transform an integer index to date index (relative to data)
+#' Transform an integer index (relative to data beginning) into a date index.
 #'
-#' @param index Date (or integer) index
-#' @param data Object of class \code{Data}
+#' @inheritParams dateIndexToInteger
 #'
 #' @export
 integerIndexToDate = function(index, data)
 {
-	#works on dates too: trust input
+	# Works on dates too: trust input
 	if (is.character(index))
 		index = as.Date(index)
 	if (is(index,"Date"))
@@ -53,28 +53,30 @@ integerIndexToDate = function(index, data)
 
 #' getSimilarDaysIndices
 #'
-#' Find similar days indices in the past.
+#' Find similar days indices in the past; at least same type of day in the week:
+#' monday=tuesday=wednesday=thursday != friday != saturday != sunday.
 #'
 #' @param index Day index (numeric or date)
 #' @param data Reference dataset, object output of \code{getData}
 #' @param limit Maximum number of indices to return
 #' @param same_season Should the indices correspond to day in same season?
+#' @param days_in Optional set to intersect with results (NULL to discard)
 #'
 #' @export
-getSimilarDaysIndices = function(index, data, limit, same_season)
+getSimilarDaysIndices = function(index, data, limit, same_season, days_in=NULL)
 {
 	index = dateIndexToInteger(index, data)
 
 	# Look for similar days (optionally in same season)
-	i = index - 1
 	days = c()
 	dt_ref = as.POSIXlt(data$getTime(index)[1]) #first date-time of current day
 	day_ref = dt_ref$wday #1=monday, ..., 6=saturday, 0=sunday
 	month_ref = as.POSIXlt(data$getTime(index)[1])$mon+1 #month in 1...12
+	i = index - 1
 	while (i >= 1 && length(days) < limit)
 	{
 		dt = as.POSIXlt(data$getTime(i)[1])
-		if (.isSameDay(dt$wday, day_ref))
+		if ((is.null(days_in) || i %in% days_in) && .isSameDay(dt$wday, day_ref))
 		{
 			if (!same_season || .isSameSeason(dt$mon+1, month_ref))
 				days = c(days, i)
@@ -86,10 +88,10 @@ getSimilarDaysIndices = function(index, data, limit, same_season)
 
 # isSameSeason
 #
-# Check if two months fall in the same "season" (defined by estimated pollution rate)
+# Check if two months fall in the same "season" (defined by estimated pollution rate).
 #
-# @param month month index to test
-# @param month_ref month to compare to
+# @param month Month index to test
+# @param month_ref Month to compare to
 #
 .isSameSeason = function(month, month_ref)
 {
@@ -102,32 +104,14 @@ getSimilarDaysIndices = function(index, data, limit, same_season)
 
 # isSameDay
 #
-# Monday=Tuesday=Wednesday=Thursday ; Friday, Saturday, Sunday: specials
+# Monday=Tuesday=Wednesday=Thursday ; Friday, Saturday, Sunday: specials.
 #
-# @param day day index to test
-# @param day_ref day index to compare to
+# @param day Day index to test
+# @param day_ref Day index to compare to
 #
 .isSameDay = function(day, day_ref)
 {
-	if (day_ref == 0)
-		return (day==0)
-	if (day_ref <= 4)
-		return (day <= 4)
+	if (day_ref %in% 1:4)
+		return (day %in% 1:4)
 	return (day == day_ref)
 }
-
-#' 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)) )
-	) ]
-}