Declare an alternative implementation of a test or model

variant() declares a named alternative implementation reachable only via via(). Never runs on the eager path.

Usage

variant(fn, print = NULL, claim_parser = NULL)

Arguments

fn

A function whose first argument must be .proc, the processed model output from model_processor(). The keys available on .proc depend on the variable mapper <var_id> used:

x_by: $x_data, $group_data
rel: $x_data, $resp_data
pairwise: $var_names, $pairs, $data
formula: $data, $vars, $formula

Try run this to explore the structure: names(model_processor(<var_id>, <data>)).

Additional named arguments are user-supplied statistical parameters (e.g. .mu, .ci). See model_processor() for the full .proc schema per model type.

variant(
    fn = function(.proc, n = 1000L, seed = NULL) {
        x = .proc$x_data[[1]]
        group_data = .proc$group_data
        # ...
    }
)

A variant whose fn returns the same class_stat_infer subclass as baseline inherits auto_tidy() and all future auto_*() methods automatically via S7's parent chain. A variant returning a subclass can override selectively:

# inherits `auto_tidy()` from `new_out` S7 class
variant(fn = function(.proc, ...) { new_out(...) })

# overrides auto_tidy() via subclass
variant(fn = function(.proc, ...) { new_out_boot(...) })

# intentionally plain
variant(fn = function(.proc, ...) { list(...) })

print

A function with signature function(x, ...). x is a cld_exec object. NULL falls back to print(x@data).

claim_parser

A map_claim() object that maps a null_claim to named arguments injected into fn alongside .proc. NULL (the default) if this variant does not support state_null().

Value

A variant S7 object.

Declare an alternative implementation of a test or model

Usage

Arguments

Value

See also