X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=pkg%2FR%2Futils.R;h=3f32868e639ef94ed3b1a3856f0c239fbcf43a8d;hb=41196789122f4b6bafeb7a306a3b4033637586f4;hp=bbf138750d21b2bdca0694980e5c1e0ff85d7acb;hpb=72b9c50162bcdcf6c99fbb8b2ec6ea9ba98379cb;p=talweg.git

diff --git a/pkg/R/utils.R b/pkg/R/utils.R
index bbf1387..3f32868 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))
@@ -30,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"))
@@ -54,7 +53,8 @@ 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}
@@ -68,11 +68,11 @@ 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])
@@ -88,10 +88,10 @@ getSimilarDaysIndices = function(index, data, limit, same_season, days_in=NULL)
 
 # 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)
 {
@@ -104,17 +104,15 @@ getSimilarDaysIndices = function(index, data, limit, same_season, days_in=NULL)
 
 # 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)
 }
 
@@ -122,12 +120,11 @@ getSimilarDaysIndices = function(index, data, limit, same_season, days_in=NULL)
 #'
 #' Get indices in data of no-NA series followed by no-NA, within [first,last] range.
 #'
-#' @param data Object of class Data
+#' @inheritParams dateIndexToInteger
 #' @param first First index (included)
 #' @param last Last index (included)
 #'
-#' @export
-getNoNA2 = function(data, first, last)
+.getNoNA2 = function(data, first, last)
 {
 	(first:last)[ sapply(first:last, function(i)
 		!any( is.na(data$getCenteredSerie(i)) | is.na(data$getCenteredSerie(i+1)) )