R/rtXDecom.R

In egenn/rtemis: Machine Learning and Visualization

# rtXDecom.R
# ::rtemis::
# 2017 E.D. Gennatas rtemis.org

#' R6 class for \pkg{rtemis} cross-decompositions
#'
#' \pkg{rtemis} cross-decomposition R6 object
#'
#' @docType class
#' @name rtXDecom-class
#' @field xdecom.name Character: Name of cross-decomposition algorithm
#' @field k Integer: Number of projections
#' @field xnames Character vector: Column names of x
#' @field znames Character vector: Column names of z
#' @field xdecom Cross-decomposition model output
#' @field xprojections.train x data training set projections
#' @field xprojections.test x data test set data projections
#' @field zprojections.train z data training set projections
#' @field zprojections.test z data test set projections
#' @field parameters Cross-decomposition parameters
#' @field extra List: Algorithm-specific output
#' @author E.D. Gennatas
#' @export

rtXDecom <- R6::R6Class("rtXDecom",
                        public = list(
                          ### Attributes
                          xdecom.name = NULL,
                          k = NULL,
                          xnames = NULL,
                          znames = NULL,
                          xdecom = NULL,
                          xprojections.train = NULL,
                          xprojections.test = NULL,
                          zprojections.train = NULL,
                          zprojections.test = NULL,
                          parameters = NULL,
                          extra = NULL,
                          ### Initialize
                          #' @param xdecom.name Character: Name of cross-decomposition algorithm
                          #' @param k Integer: Number of projections
                          #' @param xnames Character vector: Column names of x
                          #' @param znames Character vector: Column names of z
                          #' @param xdecom Cross-decomposition model output
                          #' @param xprojections.train x data training set projections
                          #' @param xprojections.test x data test set data projections
                          #' @param zprojections.train z data training set projections
                          #' @param zprojections.test z data test set projections
                          #' @param parameters Cross-decomposition parameters
                          #' @param extra List: Algorithm-specific output
                          initialize = function(xdecom.name = character(),
                                                k = integer(),
                                                xnames = character(),
                                                znames = character(),
                                                xdecom = list(),
                                                xprojections.train = numeric(),
                                                xprojections.test = numeric(),
                                                zprojections.train = numeric(),
                                                zprojections.test = numeric(),
                                                parameters = list(),
                                                extra = list()) {
                            self$xdecom.name <- xdecom.name
                            self$k <- k
                            self$xnames <- xnames
                            self$znames <- znames
                            self$xdecom <- xdecom
                            self$xprojections.train <- xprojections.train
                            self$xprojections.test <- xprojections.test
                            self$zprojections.train <- zprojections.train
                            self$zprojections.test <- zprojections.test
                            self$parameters <- parameters
                            self$extra <- extra
                          },
                          ### Methods
                          #' @description Print method for `rtXDecom` objects
                          print = function() {
                            "show / print method for rtXDecom"
                            objcat("Cross-Decomposition object")
                            cat(hilite(self$xdecom.name),
                                " (", xselect_decom(self$xdecom.name, desc = TRUE),
                                ")\n", sep = "")
                            if (length(self$parameters) > 0) printls(self$parameters,
                                                                     title = "Parameters",
                                                                     newline.pre = TRUE)
                          }
                        ))