dict_mutators_null: Null Mutator

dict_mutators_nullR Documentation

Null Mutator

Description

Null-mutator that does not perform any operation on its input. Useful in particular with operator-wrappers such as MutatorMaybe or MutatorCombination.

Configuration Parameters

This operator has no configuration parameters.

Supported Operand Types

Supported Domain classes are: p_lgl ('ParamLgl'), p_int ('ParamInt'), p_dbl ('ParamDbl'), p_fct ('ParamFct')

Dictionary

This Mutator can be created with the short access form mut() (muts() to get a list), or through the the dictionary dict_mutators in the following way:

# preferred:
mut("null")
muts("null")  # takes vector IDs, returns list of Mutators

# long form:
dict_mutators$get("null")

Super classes

miesmuschel::MiesOperator -> miesmuschel::Mutator -> MutatorNull

Methods

Public methods

Inherited methods

Method new()

Initialize the MutatorNull object.

Usage
MutatorNull$new()

Method clone()

The objects of this class are cloneable with this method.

Usage
MutatorNull$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

Other mutators: Mutator, MutatorDiscrete, MutatorNumeric, OperatorCombination, dict_mutators_cmpmaybe, dict_mutators_erase, dict_mutators_gauss, dict_mutators_maybe, dict_mutators_proxy, dict_mutators_sequential, dict_mutators_unif

Examples

mn = mut("null")
p = ps(x = p_int(-5, 5), y = p_dbl(-5, 5), z = p_lgl())
data = data.frame(x = rep(0, 5), y = rep(0, 5), z = rep(TRUE, 5))

mn$prime(p)
mn$operate(data)

miesmuschel documentation built on June 22, 2024, 9:39 a.m.