projects
/
talweg.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Improve documentation
[talweg.git]
/
pkg
/
R
/
utils.R
diff --git
a/pkg/R/utils.R
b/pkg/R/utils.R
index
bbf1387
..
3124881
100644
(file)
--- a/
pkg/R/utils.R
+++ b/
pkg/R/utils.R
@@
-1,14
+1,14
@@
#' dateIndexToInteger
#'
#' 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 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)
{
#'
#' @export
dateIndexToInteger = function(index, data)
{
- #
w
orks on integers too: trust input
+ #
W
orks on integers too: trust input
if (is.numeric(index))
index = as.integer(index)
if (is.integer(index))
if (is.numeric(index))
index = as.integer(index)
if (is.integer(index))
@@
-30,15
+30,14
@@
dateIndexToInteger = function(index, data)
#' integerIndexToDate
#'
#' 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)
{
#'
#' @export
integerIndexToDate = function(index, data)
{
- #
w
orks on dates too: trust input
+ #
W
orks on dates too: trust input
if (is.character(index))
index = as.Date(index)
if (is(index,"Date"))
if (is.character(index))
index = as.Date(index)
if (is(index,"Date"))
@@
-54,7
+53,8
@@
integerIndexToDate = function(index, data)
#' getSimilarDaysIndices
#'
#' 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 index Day index (numeric or date)
#' @param data Reference dataset, object output of \code{getData}
@@
-88,10
+88,10
@@
getSimilarDaysIndices = function(index, data, limit, same_season, days_in=NULL)
# isSameSeason
#
# 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
m
onth index to test
-# @param month_ref
m
onth to compare to
+# @param month
M
onth index to test
+# @param month_ref
M
onth to compare to
#
.isSameSeason = function(month, month_ref)
{
#
.isSameSeason = function(month, month_ref)
{
@@
-104,10
+104,10
@@
getSimilarDaysIndices = function(index, data, limit, same_season, days_in=NULL)
# isSameDay
#
# isSameDay
#
-# Monday=Tuesday=Wednesday=Thursday ; Friday, Saturday, Sunday: specials
+# Monday=Tuesday=Wednesday=Thursday ; Friday, Saturday, Sunday: specials
.
#
#
-# @param day
d
ay index to test
-# @param day_ref
d
ay index to compare to
+# @param day
D
ay index to test
+# @param day_ref
D
ay index to compare to
#
.isSameDay = function(day, day_ref)
{
#
.isSameDay = function(day, day_ref)
{
@@
-122,7
+122,7
@@
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.
#'
#'
#' 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)
#'
#' @param first First index (included)
#' @param last Last index (included)
#'