rollingByCalcs: Rolling Calculations Based Off of Dates (or numbers) With a...

In mgahan/boRingTrees: A Package for UIUC Ecologists

Description

Compute rolling calcs such as length (counts), sum, min, max, or median

Usage

rollingByCalcs(data, bylist = NULL, dates, target = NULL, lower, upper,
  incbounds = T, stat = length, na.rm = T, cores = 1)

Arguments

data	A data.frame or data.table
bylist	A reference list of variables to pivot off (e.g. c("Cust.ID","Prod.ID")).
dates	A reference to the name of the dates column in data
target	Reference to column in data you want to perform calculations on. If target=NULL, then only rolling count operations will be performed
lower	The lower bound of the date range (e.g. lower=0)
upper	The upper bound of the date range (e.g. upper=31)
incbounds	TRUE means inclusive bounds i.e. [lower,upper]. FALSE means exclusive bounds i.e. (lower,upper).
stat	Default is length (calculates rolling counts). Can also use mean, median, min, max
na.rm	a logical value indicating whether NA values should be stripped before the computation proceeds.
cores	If using a Mac or Linux, this forks out the process in the amount of cores you desire. This could be useful in speeding up the code. Defaults to 1. Windows users should use 1.

Value

A vector of the desired rolling calculation

Note

A couple examples of how to use lower,upper, and incbounds : If you want to get rolling sum of the past 31 days (including the current day) lower=0, upper=31, incbounds=T. If you want to get rolling sum of the next 31 days (including the current day) lower=-31, upper=0, incbounds=T. If you want to get rolling sum of the next 31 days (excluding the current day and the 31st day in future) lower=-31, upper=0, incbounds=F.

Examples

set.seed(1)
Trans_Dates <- as.Date(c(31,33,65,96,150,187,210,212,240,273,293,320,
                        32,34,66,97,151,188,211,213,241,274,294,321,
                        33,35,67,98,152,189,212,214,242,275,295,322),origin="2010-01-01")
Cust_ID <- c(rep(1,12),rep(2,12),rep(3,12))
Target <- rpois(36,3)
require("data.table")
data <- data.table(Trans_Dates,Cust_ID,Target)
data[,Roll:=rollingByCalcs(data=data,bylist="Cust_ID",dates="Trans_Dates",
                          target="Target",lower=0,upper=31,incbounds=T,stat=sum,na.rm=T,cores=1)]
print(data)

mgahan/boRingTrees documentation built on May 22, 2019, 8:53 p.m.