dataHolder: dataHolder

In ericdunipace/causalOT: Optimal Transport Weights for Causal Inference

dataHolder

Description

dataHolder

Usage

dataHolder(x, z, y = NA_real_, weights = NA_real_)

Arguments

x	the covariate data. Can be a matrix, an object of class dataHolder or a DataSim object. The latter two object types won't need arguments z or y.
z	the treatment indicator
y	the outcome data
weights	the empirical distribution of the sample

Details

Creates an object used internally by the causalOT package for data management.

Value

Returns an object of class dataHolder with slots

• x matrix. A matrix of confounders.

• z integer. The treatment indicator, z_i \in \{0,1\}.

• y numeric. The outcome data.

• n0 integer. The number of observations where z==0

• n1 integer. The number of observations where z==1

• weights numeric. The empirical distribution of the full sample.

Examples

x <- matrix(0, 100, 10)
z <- stats::rbinom(100, 1, 0.5)

# don't need to provide outcome
# function will assume each observation gets equal mass
dataHolder(x = x, z = z) 

ericdunipace/causalOT documentation built on Aug. 8, 2024, 6:14 p.m.