Compute the mean or sum over an infinite or finite sliding time window, returning a vector the same size as the lookback times.
t_running_sum(
v,
time = NULL,
time_deltas = NULL,
window = NULL,
wts = NULL,
lb_time = NULL,
na_rm = FALSE,
min_df = 0L,
restart_period = 10000L,
variable_win = FALSE,
wts_as_delta = TRUE,
check_wts = FALSE
)t_running_mean(
v,
time = NULL,
time_deltas = NULL,
window = NULL,
wts = NULL,
lb_time = NULL,
na_rm = FALSE,
min_df = 0L,
restart_period = 10000L,
variable_win = FALSE,
wts_as_delta = TRUE,
check_wts = FALSE
)
A vector the same size as the lookback times.
a vector.
an optional vector of the timestamps of v. If given, must be
the same length as v. If not given, we try to infer it by summing the
time_deltas.
an optional vector of the deltas of timestamps. If given, must be
the same length as v. If not given, and wts are given and wts_as_delta is true,
we take the wts as the time deltas. The deltas must be positive. We sum them to arrive
at the times.
the window size, in time units. if given as finite integer or double, passed through.
If NULL, NA_integer_, NA_real_ or Inf are given,
and variable_win is true, then we infer the window from the lookback times: the
first window is infinite, but the remaining is the deltas between lookback times.
If variable_win is false, then these undefined values are equivalent to an
infinite window.
If negative, an error will be thrown.
an optional vector of weights. Weights are ‘replication’
weights, meaning a value of 2 is shorthand for having two observations
with the corresponding v value. If NULL, corresponds to
equal unit weights, the default. Note that weights are typically only meaningfully defined
up to a multiplicative constant, meaning the units of weights are
immaterial, with the exception that methods which check for minimum df will,
in the weighted case, check against the sum of weights. For this reason,
weights less than 1 could cause NA to be returned unexpectedly due
to the minimum condition. When weights are NA, the same rules for checking v
are applied. That is, the observation will not contribute to the moment
if the weight is NA when na_rm is true. When there is no
checking, an NA value will cause the output to be NA.
a vector of the times from which lookback will be performed. The output should
be the same size as this vector. If not given, defaults to time.
whether to remove NA, false by default.
the minimum df to return a value, otherwise NaN is returned,
only for the means computation.
This can be used to prevent moments from being computed on too few observations.
Defaults to zero, meaning no restriction.
the recompute period. because subtraction of elements can cause loss of precision, the computation of moments is restarted periodically based on this parameter. Larger values mean fewer restarts and faster, though potentially less accurate results. Unlike in the computation of even order moments, loss of precision is unlikely to be disastrous, so the default value is rather large.
if true, and the window is not a concrete number,
the computation window becomes the time between lookback times.
if true and the time and time_deltas are not
given, but wts are given, we take wts as the time_deltas.
a boolean for whether the code shall check for negative weights, and throw an error when they are found. Default false for speed.
This function supports time (or other counter) based running computation. Here the input are the data \(x_i\), and optional weights vectors, \(w_i\), defaulting to 1, and a vector of time indices, \(t_i\) of the same length as \(x\). The times must be non-decreasing: $$t_1 \le t_2 \le \ldots$$ It is assumed that \(t_0 = -\infty\). The window, \(W\) is now a time-based window. An optional set of lookback times are also given, \(b_j\), which may have different length than the \(x\) and \(w\). The output will correspond to the lookback times, and should be the same length. The \(j\)th output is computed over indices \(i\) such that $$b_j - W < t_i \le b_j.$$
For comparison functions (like Z-score, rescaling, centering), which compare values of \(x_i\) to local moments, the lookbacks may not be given, but a lookahead \(L\) is admitted. In this case, the \(j\)th output is computed over indices \(i\) such that $$t_j - W + L < t_i \le t_j + L.$$
If the times are not given, ‘deltas’ may be given instead. If \(\delta_i\) are the deltas, then we compute the times as $$t_i = \sum_{1 \le j \le i} \delta_j.$$ The deltas must be the same length as \(x\). If times and deltas are not given, but weights are given and the ‘weights as deltas’ flag is set true, then the weights are used as the deltas.
Some times it makes sense to have the computational window be the space between lookback times. That is, the \(j\)th output is to be computed over indices \(i\) such that $$b_{j-1} - W < t_i \le b_j.$$ This can be achieved by setting the ‘variable window’ flag true and setting the window to null. This will not make much sense if the lookback times are equal to the times, since each moment computation is over a set of a single index, and most moments are underdefined.
Steven E. Pav shabbychef@gmail.com
Computes the mean or sum of the elements, using a Kahan's Compensated Summation Algorithm, a numerically robust one-pass method.
Given the length \(n\) vector \(x\), we output matrix \(M\) where
\(M_{i,1}\) is the sum or mean
of some elements \(x_i\) defined by the sliding time window.
Barring NA or NaN, this is over a window of time width window.
Terriberry, T. "Computing Higher-Order Moments Online." https://web.archive.org/web/20140423031833/http://people.xiph.org/~tterribe/notes/homs.html
J. Bennett, et. al., "Numerically Stable, Single-Pass, Parallel Statistics Algorithms," Proceedings of IEEE International Conference on Cluster Computing, 2009. tools:::Rd_expr_doi("10.1109/CLUSTR.2009.5289161")
Cook, J. D. "Accurately computing running variance." https://www.johndcook.com/standard_deviation/
Cook, J. D. "Comparing three methods of computing standard deviation." https://www.johndcook.com/blog/2008/09/26/comparing-three-methods-of-computing-standard-deviation/
Kahan, W. "Further remarks on reducing truncation errors," Communications of the ACM, 8 (1), 1965. tools:::Rd_expr_doi("10.1145/363707.363723")
Wikipedia contributors "Kahan summation algorithm," Wikipedia, The Free Encyclopedia, https://en.wikipedia.org/w/index.php?title=Kahan_summation_algorithm&oldid=777164752 (accessed May 31, 2017).
x <- rnorm(1e5)
xs <- t_running_sum(x,time=seq_along(x),window=10)
xm <- t_running_mean(x,time=cumsum(runif(length(x))),window=7.3)
Run the code above in your browser using DataLab