#' 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))
#' 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"))
#' 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}
# 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)
{
# 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)
{
#'
#' 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)
#'