Configuration of Known Model

Known_cfg is a configuration class for when a particular model is known a-priori. The prototypical usage of this class is when heterogeneous treatment effects are estimated in the context of a randomized control trial with known propensity scores.

Super class

tidyhte::Model_cfg -> Known_cfg

Public fields

covariate_name

The name of the column in the dataset which corresponds to the known model score.

model_class

The class of the model, required for all classes which inherit from Model_cfg.

Methods

Public methods

• Known_cfg$new()

• Known_cfg$clone()

---

Method new()

Create a new Known_cfg object with specified covariate column.

Usage

Known_cfg$new(covariate_name)

Arguments

covariate_name

The name of the column, a string, in the dataset corresponding to the known model score (i.e. the true conditional expectation).

Returns

A new Known_cfg object.

Examples

Known_cfg$new("propensity_score")

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Known_cfg$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `Known_cfg$new`
## ------------------------------------------------

Known_cfg$new("propensity_score")
#> <Known_cfg>
#>   Inherits from: <Model_cfg>
#>   Public:
#>     clone: function (deep = FALSE) 
#>     covariate_name: propensity_score
#>     initialize: function (covariate_name) 
#>     model_class: known