added sales.x to elog2cbs output (#54)

fixes #54

Author: mplatzer

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: BTYDplus
 Type: Package
 Title: Probabilistic Models for Assessing and Predicting your Customer Base
-Version: 1.1.0
+Version: 1.1.1
 Authors@R: person("Michael", "Platzer", email = "[email protected]", role = c("aut", "cre"))
 Description: Provides advanced statistical methods to describe and predict customers'
   purchase behavior in a non-contractual setting. It uses historic transaction records to fit a
@@ -32,6 +32,6 @@ Suggests:
     rmarkdown,
     lintr (>= 1.0.0)
 Roxygen: list(wrap = FALSE)
-RoxygenNote: 5.0.1
+RoxygenNote: 6.0.1
 LazyData: true
 VignetteBuilder: knitr

NEWS

@@ -1,3 +1,6 @@
+1.1.1
+- added `sales.x` to `elog2cbs` output, which sums over sales in calibration, but excludes initial transaction (thanks to msinjin for the suggestion)
+
 1.1.0
 - added `(m)bgcnbd.PlotFreqVsConditionalExpectedFrequency` methods
 - added `(m)bgcnbd.PlotRecVsConditionalExpectedFrequency` methods

R/helpers.R

@@ -262,7 +262,8 @@ plotTimingPatterns <- function(elog, n = 40, T.cal = NULL, T.tot = NULL,
 #'  \item{\code{x}}{Number of recurring events in calibration period.}
 #'  \item{\code{t.x}}{Time between first and last event in calibration period.}
 #'  \item{\code{litt}}{Sum of logarithmic intertransaction timings during calibration period.}
-#'  \item{\code{sales}}{Sum of sales in calibration period. Only if \code{elog$sales} is provided.}
+#'  \item{\code{sales}}{Sum of sales in calibration period, incl. initial transaction. Only if \code{elog$sales} is provided.}
+#'  \item{\code{sales.x}}{Sum of sales in calibration period, excl. initial transaction. Only if \code{elog$sales} is provided.}
 #'  \item{\code{first}}{Date of first transaction in calibration period.}
 #'  \item{\code{T.cal}}{Time between first event and end of calibration period.}
 #'  \item{\code{T.star}}{Length of holdout period. Only if \code{T.cal} is provided.}
@@ -274,7 +275,7 @@ plotTimingPatterns <- function(elog, n = 40, T.cal = NULL, T.tot = NULL,
 #' cbs <- elog2cbs(groceryElog, T.cal = "2006-12-31", T.tot = "2007-12-30")
 #' head(cbs)
 elog2cbs <- function(elog, units = "week", T.cal = NULL, T.tot = NULL) {
-  cust <- first <- itt <- T.star <- x.star <- sales <- sales.star <- NULL  # suppress checkUsage warnings
+  cust <- first <- itt <- T.star <- x.star <- sales <- sales.star <- sales.x <- NULL  # suppress checkUsage warnings
   stopifnot(inherits(elog, "data.frame"))
   if (!all(c("cust", "date") %in% names(elog))) stop("`elog` must have fields `cust` and `date`")
   if (!any(c("Date", "POSIXt") %in% class(elog$date))) stop("`date` field must be of class `Date` or `POSIXt`")
@@ -311,7 +312,8 @@ elog2cbs <- function(elog, units = "week", T.cal = NULL, T.tot = NULL) {
                  list(x = .N - 1,
                       t.x = max(t),
                       litt = sum(log(itt[itt > 0])),
-                      sales = sum(sales)),
+                      sales = sum(sales),
+                      sales.x = sum(sales[t > 0])),
                  by = "cust,first"]
   cbs[, `:=`(T.cal, as.numeric(difftime(T.cal, first, units = units)))]
   setkey(cbs, cust)
@@ -322,14 +324,16 @@ elog2cbs <- function(elog, units = "week", T.cal = NULL, T.tot = NULL) {
     cbs <- merge(cbs, val, all.x = TRUE, by = "cust")
     cbs[is.na(x.star), `:=`(x.star, 0)]
     cbs[is.na(sales.star), `:=`(sales.star, 0)]
-    setcolorder(cbs, c("cust", "x", "t.x", "litt", "sales", "first", "T.cal", "T.star", "x.star", "sales.star"))
+    setcolorder(cbs, c("cust", "x", "t.x", "litt", "sales", "sales.x", "first", "T.cal",
+                       "T.star", "x.star", "sales.star"))
   } else {
-    setcolorder(cbs, c("cust", "x", "t.x", "litt", "sales", "first", "T.cal"))
+    setcolorder(cbs, c("cust", "x", "t.x", "litt", "sales", "sales.x", "first", "T.cal"))
   }
   # return same object type as was passed
   if (!has.sales) {
     elog_dt[, `:=`(sales, NULL)]
     cbs[, `:=`(sales, NULL)]
+    cbs[, `:=`(sales.x, NULL)]
     if (has.holdout) cbs[, `:=`(sales.star, NULL)]
   }
   if (!is.dt) {