R/class_clv_data_dynamiccovariates.R

In bachmannpatrick/CLVTools: Tools for Customer Lifetime Value Estimation

#' Transactional and dynamic covariates data to fit CLV models
#'
#' @description
#' Extends the class \linkS4class{clv.data.static.covariates},
#' but adds no additional slots to it. The purpose of this class rather is to define different behaviors
#' suitable for dynamic covariates.
#'
#' The \code{data.table}s stored in the slots \code{data.cov.life} and \code{data.cov.trans}
#' each contain an additional column \code{Cov.Date} for the timepoint of the covariate.
#'
#' An object of this class serves as input to fit models with dynamic covariates.
#'
#'
#' @slot data.cov.life Single \code{data.table} with all static covariate data for the lifetime process
#' @slot data.cov.trans Single \code{data.table} with all static covariate data for the transaction process
#' @slot names.cov.data.life Character vector with names of the dynamic lifetime covariates.
#' @slot names.cov.data.trans Character vector with names of the dynamic transaction covariates.
#'
#' @seealso Definition of the parent class \linkS4class{clv.data.static.covariates}.
#' @seealso For fitting dynamic covariate models: \code{\link[CLVTools:pnbd]{pnbd}}
#'
# Corresponds to the column names of the \code{data.table} in slot data.cov.trans
#'
#' @keywords internal
#' @importFrom methods setClass
#' @include all_generics.R class_clv_data.R class_clv_data_staticcovariates.R class_clv_time.R
setClass(Class = "clv.data.dynamic.covariates", contains = "clv.data.static.covariates")


#' @importFrom methods new
clv.data.dynamic.covariates <- function(no.cov.obj,
                                        data.cov.life,
                                        data.cov.trans,
                                        names.cov.data.life,
                                        names.cov.data.trans){


  return(new("clv.data.dynamic.covariates",
                 # no need for deep copy as done in static cov constructor
                 clv.data.static.covariates(no.cov.obj = no.cov.obj,
                                            names.cov.data.life  = names.cov.data.life,
                                            names.cov.data.trans = names.cov.data.trans,

                                            data.cov.life  = data.cov.life,
                                            data.cov.trans = data.cov.trans),

                 name = "CLV Transaction Data with Dynamic Covariates",

                 names.cov.data.life  = names.cov.data.life,
                 names.cov.data.trans = names.cov.data.trans))
}