R/weightsClass.R

In ericdunipace/causalOT: Optimal Transport Weights for Causal Inference

#' causalWeights class
#'
#' @slot w0 A slot with the weights for the control group with \eqn{n_0} entries. Weights sum to 1.
#' @slot w1 The weights for the treated group with \eqn{n_1} entries. Weights sum to 1.
#' @slot estimand A character denoting the estimand targeted by the weights. One of "ATT","ATC", or "ATE".
#' @slot info A slot to store a variety of info for inference. Currently under development.
#' @slot method A character denoting the method used to estimate the weights.
#' @slot penalty A list or the selected penalty parameters, if relevant.
#' @slot data The dataHolder object containing the original data.
#' @slot call The call used to construct the weights.
#'
#' @docType class
#' @include dataHolder.R
#' 
#' @details This object is returned by the `calc_weight` function in this package. The slots can be accessed as any S4 object. There is no publicly accessible constructor function. 
#' 
#'
#' @export
setClass("causalWeights", slots = c(w0 = "numeric", w1 = "numeric",
                                    estimand = "character",
                                    method = "character", 
                                    penalty = "list",
                                    info = "list",
                                    data = "dataHolder",
                                    call = "call"))


setGeneric("causalWeights", function(object1, object2, ...) standardGeneric("causalWeights"))


setMethod("causalWeights", signature(object1 = "causalWeights", object2 = "causalWeights"), 
function(object1, object2, ...) {
  stopifnot(object1@estimand == "ATE.C")
  stopifnot(object2@estimand == "ATE.T")
  
  methods::new("causalWeights",
    w0 = object1@w0,
    w1 = object2@w1,
    estimand = "ATE",
    method = object1@method,
    penalty = list(w0 = object1@penalty[[1]],
                   w1 = object2@penalty[[1]]),
    info = list(w0 = object1@info,
                w1 = object2@info),
    data = object1@data,
    call = object1@call
  )
  
}
)