DataSim-CRASH3: CRASH3 data example

In ericdunipace/causalOT: Optimal Transport Weights for Causal Inference

CRASH3 data example

Description

CRASH3 data example

CRASH3 data example

Details

Returns the CRASH3 data. Note that gen_data() will initialize the fixed data for x and y, but z is generated from Binom(0.5).

Value

An R6 object of class DataSim

Super class

causalOT::DataSim -> CRASH3

Public fields

site_id

The site of the observation in terms of the original RCT.

Methods

Public methods

• CRASH3$gen_data()

• CRASH3$gen_x()

• CRASH3$gen_y()

• CRASH3$gen_z()

• CRASH3$new()

• CRASH3$clone()

Inherited methods

• causalOT::DataSim$get_n()
• causalOT::DataSim$get_p()
• causalOT::DataSim$get_tau()
• causalOT::DataSim$get_x()
• causalOT::DataSim$get_x0()
• causalOT::DataSim$get_x1()
• causalOT::DataSim$get_y()
• causalOT::DataSim$get_z()

---

Method gen_data()

The site ID for the observations

Draws new treatment indicators. x and y data are fixed.

Usage

CRASH3$gen_data()

---

Method gen_x()

Sets up the covariate data. This data is fixed.

Usage

CRASH3$gen_x()

---

Method gen_y()

Sets up the outcome data. This data is fixed.

Usage

CRASH3$gen_y()

---

Method gen_z()

Sets up the treatment indicator. Drawn as Z ~ Binom(0.5)

Usage

CRASH3$gen_z()

---

Method new()

Initializes the CRASH3 object.

Usage

CRASH3$new(n = NULL, p = NULL, param = list(), design = NA_character_, ...)

Arguments

n

Not used. Maintained for symmetry with other DataSim objects.

p

Not used. Maintained for symmetry with other DataSim objects.

param

Not used. Maintained for symmetry with other DataSim objects.

design

Not used

...

Not used.

Examples

crash <- CRASH3$new()
crash$gen_data()
crash$get_n()
crash$site_id

---

Method clone()

The objects of this class are cloneable with this method.

Usage

CRASH3$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `CRASH3$new`
## ------------------------------------------------

crash <- CRASH3$new()
crash$gen_data()
crash$get_n()
crash$site_id

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