Configuration for a Stratification Estimator

Stratified_cfg is a configuration class for stratifying a covariate and calculating statistics within each cell.

Super class

tidyhte::Model_cfg -> Stratified_cfg

Public fields

model_class

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

covariate

The name of the column in the dataset which corresponds to the covariate on which to stratify.

Methods

Public methods

• Stratified_cfg$new()

• Stratified_cfg$clone()

---

Method new()

Create a new Stratified_cfg object with specified number of evaluation points.

Usage

Stratified_cfg$new(covariate)

Arguments

covariate

The name of the column in the dataset which corresponds to the covariate on which to stratify.

Returns

A new Stratified_cfg object.

Examples

Stratified_cfg$new(covariate = "test_covariate")

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Stratified_cfg$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `Stratified_cfg$new`
## ------------------------------------------------

Stratified_cfg$new(covariate = "test_covariate")
#> <Stratified_cfg>
#>   Inherits from: <Model_cfg>
#>   Public:
#>     clone: function (deep = FALSE) 
#>     covariate: test_covariate
#>     initialize: function (covariate) 
#>     model_class: Stratified