.k_by

Converts k and lag from time-unit-interval to int

internal

Lightweight library for rolling windows operations. Package enables
full control over the window length, window lag and a time indices. With a runner
one can apply any R function on a rolling windows. The package eases work with
equally and unequally spaced time series.

Dawid Ka<c5><82><c4><99>dkowski

runner

Running Operations for Vectors

Dawid Kałędkowski

.k_by function

<dl><dt>k</dt>
<dd>(<code>integer</code> vector or single value) 
Denoting size of the running window. If <code>k</code> is a single value then window
size is constant for all elements, otherwise if <code>length(k) == length(x)</code>
different window size for each element. One can also specify <code>k</code> in the same
way as <code>by</code> argument in <code><a href="/link/base%3A%3Aseq.POSIXt()?package=runner&version=0.4.4" data-mini-rdoc="runner::base::seq.POSIXt()">base::seq.POSIXt()</a></code>.
See 'Specifying time-intervals' in details section.</dd>
<dt>idx</dt>
<dd>(<code>integer</code>, <code>Date</code>, <code>POSIXt</code>) 
Optional integer vector containing sorted (ascending) index of observation.
By default <code>idx</code> is index incremented by one. User can provide index with
varying increment and with duplicated values. If specified then <code>k</code> and
<code>lag</code> are depending on <code>idx</code>. Length of <code>idx</code> have to be equal of length
<code>x</code>.</dd>
<dt>param</dt>
<dd>name of the parameter to be printed in error message</dd></dl>

Arguments

Converts k and lag from time-unit-interval to int — .k_by

<dl>

<dt>k</dt>
<dd>(<code>integer</code> vector or single value) 
Denoting size of the running window. If <code>k</code> is a single value then window
size is constant for all elements, otherwise if <code>length(k) == length(x)</code>
different window size for each element. One can also specify <code>k</code> in the same
way as <code>by</code> argument in <code><a href='https://rdrr.io/r/base/seq.POSIXt.html'>base::seq.POSIXt()</a></code>.
See 'Specifying time-intervals' in details section.</dd>


<dt>idx</dt>
<dd>(<code>integer</code>, <code>Date</code>, <code>POSIXt</code>) 
Optional integer vector containing sorted (ascending) index of observation.
By default <code>idx</code> is index incremented by one. User can provide index with
varying increment and with duplicated values. If specified then <code>k</code> and
<code>lag</code> are depending on <code>idx</code>. Length of <code>idx</code> have to be equal of length
<code>x</code>.</dd>


<dt>param</dt>
<dd>name of the parameter to be printed in error message</dd>

</dl>

.k_by: Converts k and lag from time-unit-interval to int

Description

Usage

Arguments

Examples